Cisco D9800 Reference Manual Download | Manualshive

Page: 107 / 294

background image

Description

Output Field

HDMI Color Space

Type: String

Value: "Unknown", "YCbCr420", "YCbCr444", "YCbCr422",
"RGB"

colorspace

HDMI Color Depth

Type: String

Value: "Unknown", "16bit", "12bit", "10bit", "8bit"

colordepth

HDMI Color Range

Type: String

Value: "Auto", "Full", "Limited"

colorrange

HDMI Matrix Coefficients

Type: String

Value: "Unknown", "ITU-2020-CL", "ITU-2020-NCL", "ITU-470",
"XvYCC-709", "XvYCC-601", "ITU-709", "SMPTE-170M"

matrixcoeff

HDMI EOTF (Electro-Optical Transfer Function)

Type: String

Value: "Unknown", "SMPTE-2084", "HDR", "SDR"

eotf

Input example (request JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/hdmi?js=1"

Expected output (values are for example purposes only):

{

"decode": {

"hdmi": [

{

"hdmiindex": "1",
"connected": "No",
"powered": "No",
"monitorname": "Unknown",
"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

95

API Definitions

HDMI Decode Status Command

«
...
105
106
107
108
109
...
»

Summary of Contents for D9800

Page 1: ...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 USA http www cisco com Tel 408 526 4000 800 553 NETS 6387 Fax 408 527 0883 ...

Page 2: ...t authorized by Cisco could void the FCC approval and negate your authority to operate the product The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California Berkeley UCB as part of UCB s public domain version of the UNIX operating system All rights reserved Copyright 1981 Regents of the University of California NOTWITHSTANDING ANY OT...

Page 3: ...rvices API 1 Access Level Login and Logout 2 HTTP Request Methods 3 Get 3 Post 4 HTTP Responses 4 HTTP Status Codes 5 Content Response Types 5 XML or JSON Response Body 6 Base URI 7 URI Parameters 7 URI Arguments 7 Access Type 8 Port Information 8 C H A P T E R 2 API Definitions 11 Legacy API 11 Backup Command 11 Restore Command 13 Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Se...

Page 4: ...Command 39 Zixi Input Status Command 44 PE Status Command 48 CA PowerVu Status Command 52 CI Common Interface CAM Status Command 54 CISYS Status Command 56 Useraddr Status Command 58 Output Status Command 59 ASI Output Status Command 66 MOIP Output Status 70 DPM PID Output Status Command 72 DPM Active Collisions Status Command 77 Video Decode Status Command 81 Audio Decode Status Command 83 Audio ...

Page 5: ...nput Configuration Command 135 RF Input Configuration Command 138 ASI Input Configuration Command 145 MOIP Input Configuration Command 149 MOIP Input Source Filters Configuration Command 156 MOIP Input Source Select Configuration Command 158 ABR Input Configuration Command 162 Zixi Input Configuration Command 166 PE Configuration Command 173 Output Configuration Command 177 ASI Global Output Confi...

Page 6: ...41 Transcoding Configuration Commands 244 HD Transcode Configuration Command 245 SD Transcode Configuration Command 248 SUBT Subtitle Transcode Configuration Command 253 User Configuration Command 256 Disaster Recovery D R Configuration API 258 Disaster Recovery D R Global Configuration Command 258 Disaster Recovery D R Backup Transport Configuration Command 260 Disaster Recovery D R Backup Channe...

Page 7: ...IP Diagnostics Report Retrieval Command 281 Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide vii Contents ...

Page 8: ...Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide viii Contents ...

Page 9: ...t application to interface with the D9800 Network Transport Receiver Conventions This guide uses the following conventions Indication Conventions Commands and keywords and user entered text appear in bold font bold font Document titles new or emphasized terms and arguments for which you supply values are in italic font italic font Elements in square brackets are optional Required alternative keywo...

Page 10: ... be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device SAVE THESE INSTRUCTIONS Warning Related Documentation Cisco D9800 Network Transport Receiver Installation and Configuration G...

Page 11: ...rmation see What s New in Cisco Product Documentation To receive new and revised Cisco technical content directly to your desktop you can subscribe to the What s New in Cisco Product Documentation RSS feed RSS feeds are a free service Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide xi Preface Obtaining Documentation and Submitting a Service Request ...

Page 12: ...Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide xii Preface Obtaining Documentation and Submitting a Service Request ...

Page 13: ...oncurrent access authentication authorization and so on All APIs are implemented using HTTP protocol and run on standard web servers using TCP port 80 or 443 for HTTPS Accessing Web Services API This document assumes that the IP address of the unit being accessed is 192 168 0 1 When copying or pasting into a cURL console you must replace 192 168 0 1 in the message with the IP address of the target...

Page 14: ...gout on page 2 Access Level Login and Logout When you successfully log in to a session an access level is assigned Access levels are confirmed on a per API basis and depending on the access level the behavior of the API may change 1 No Access No session available 2 Guest Guest session is active 3 User User session is active 4 Admin Admin session is active The following is an example of the Login c...

Page 15: ...ormatted in either XML or JSON The following is an example of a Request in XML curl k i H X SESSION ID token https 192 168 0 1 ws v2 service_cfg input rf port 2 Or curl k https 192 168 0 1 ws v2 service_cfg input rf port 2 session token The following is an example of a Request in JSON by specifying js 1 curl k i H X SESSION ID token https 192 168 0 1 ws v2 service_cfg input rf port 1 js 1 Or curl ...

Page 16: ...l data from command line curl k i H X SESSION ID token X POST header Content type application xml d Input RF Port 1 Port Act Yes Act RF Input https 192 168 0 1 ws v2 service_cfg input session token Or curl k i X POST header Content type application xml d Input RF Port 1 Port Act Yes Act RF Input https 192 168 0 1 ws v2 service_cfg input session token 3 Using xml data from file curl k i H X SESSION...

Page 17: ...nked 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 403_HTTP_FORBIDDEN 404_HTTP_NOT_FOUND 500_HTTP_INTERNAL_SERVER_ERROR 501_HTTP_NOT_IMPLEMENTED 502_HTTP_BAD_GATEWAY 503_HTTP_SERVICE_UNAVAILABLE 504_HTTP_GATEWAY_TIMEOUT 505_HTTP_VERSION_NOT_...

Page 18: ...Isttunerea User_Change tunereason User freqmode NIT swclstmode Rigorous baten No niten Yes sdten No paten No If an error occurs a generic failed response body is provided to indicate the API failed and a text message to indicate the failure reason For example curl k H X_SESSION ID token https 192 168 0 1 ws v2 status input rf port 1 js 1 response code 10 result failed message Access denied must be...

Page 19: ... API can change the type of information requested by providing a URI parameter such as inventory or id eeprom https 192 168 0 1 ws v2 test show inventory https 192 168 0 1 ws v2 test show id eeprom URI parameters should be used separately and are separated from the base URI by character URI Arguments Options are additional variables that an API can accept as input Options are separated from URI pa...

Page 20: ... eeprom for the argument card should be interpreted as card argument can be used in conjunction only with URI parameters id eeprom status eeprom Access Type This field indicates the type and direction of interaction with the web services API The valid types are Read Reading parameters from the D9800 receiver Write Write parameters to the D9800 receiver Read Write Read or write parameters from or t...

Page 21: ...sed on NTC MOIP and NTC MS boards DATA3 and DATA4 is port 3 and port 4 respectively They can only be used on the NTC MS board When connecting to a unit to run web services API commands the Management port port 0 is used to establish and maintain the connection Note The ports are labeled on the backplane of an assembled unit The Management port port 0 is labeled Management The DATA ports are labele...

Page 22: ...Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide 10 Web Services API Port Information ...

Page 23: ...mmand syntax for the cases of the restore_upload html and cdt_upload html usage and are similar in behavior to those that were implemented in previous D98xx products Backup Command Table 1 Command Details Description Command Detail https 192 168 0 1 ws v1 backup t option Command URL Backup specific types of database data from the device to your local machine Command Information GET HTTP Method Rea...

Page 24: ...all overhead Prior to the completion of the command the BKPRSTSTAT UIC table is incremented with internal state changes and incremental progress percent completions up to 100 However these state changes may occur faster than they are polled When the command is completed the BKPRSTSTAT UIC table Operation Status state will set back to Idle and the Progress percentage will set back to 0 in preparati...

Page 25: ...tus Idle and percentCompleted 0 Upon successful completion of the Restore operation the BKPRSTSTAT table will indicate that the operationStatus Pass while detailedStatus Idle and percentCompleted 100 In order to successfully start the command from either of these states without receiving a race logic condition in which false Pass will be indicated any poll loop that runs after starting the restore...

Page 26: ...name is UD9800 bkp Input curl k i H X SESSION ID token X POST F restorefile C projects d9800 UD9800 bkp https 192 168 0 1 restore_upload html Expected output html body body html The XML response is immediate and does not indicate that the restore command operation is completed The progress and results of the Restore command may be determined by calling the BKPRSTSTAT command every few seconds unti...

Page 27: ...e last restore performed HELP_STR_1 HELP_STR_2 CDATA Item attribute min max 2900 12 31 23 59 59 HELP_STR_2 ITEM ITEM ID 0x002D124B ID VALUE CDATA Pass VALUE 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 available HELP_STR_2 ITEM ITEM ID 0x002D124C ID VALUE CDATA Idle VALUE HELP_STR_1 CDATA State of t...

Page 28: ...mand line client software that uses libcurl native C library Java Python bindings PHP or Java Script does not have the limitation or requirement to split the source file up into many chunks In these cases the language support allows using byte array buffers and HTML header creation methods to format and send the chunked multi part HTML form POST commands Note In order to overcome the command line ...

Page 29: ...ader is added to the command line with the H option 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 17 API Definitions Legacy CDT Upload Command ...

Page 30: ... where a new POST command is formatted and called for each file chunk start_offset end_offset 1 If using chunky method from command line requires bash script contact D9800 Technical support for a working bash script example Cisco Engineering or Test personnel may use internal downloader tools employing one or more high level languages that do not have the same restrictions as the command line synt...

Page 31: ...6c7 r n r n 9d4ffbe5a6c7 r n Content Disposition form data name cdtfile r n Content Type application octet stream r n r n a lot of binary data where end_chunk 1 start_chunk is number of bytes size ie Content Range is inclusive r n 9d4ffbe5a6c7 r n Determining Support for Chunky CDT Upload Command Table 8 Command Details Description Command Detail https 192 168 0 1 ws v2 device_ctl download Command...

Page 32: ...is not used by the D9800 Web UI which is integrated within the target application software during fie upload dlhttpchunk optional Read Only Example Retrieve Download Feature support using Version 2 75 or earlier Input curl i k H X SESSION ID token http 192 168 0 1 ws v2 device_ctl download Expected output full HTTP response must be checked where 200 indicates that command is implemented and all ot...

Page 33: ...ic for interpreting the command response If the HTTP response is 200 OK the client software must check the dlhttpchunk value if the dlhttpchunk value is Enabled the client code may use the Chunky CDT Upload command else the client software must use the Legacy CDT Upload command else the client software must use the Legacy CDT Upload command Upload Software License File Command Table 10 Command Det...

Page 34: ...tion and then perform a file transfer In Version 2 50 and higher the required client software operation is as follows 1 Trigger a request for a diagnostic package creation Diagnostics Trigger Command 2 Wait for the status Diagnostics Operation Status API 3 Transfer the file Diagnostics Retrieval command Diagnostics Package Trigger Command Table 11 Command Details Description Command Detail https 1...

Page 35: ...TABLE RECORD ITEM ID 0x002D25CD ID VALUE CDATA Inprogress VALUE N AME 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 available HELP_STR_2 ITEM ITEM ID 0x002D25CE ID VALUE CDATA Processing VALUE NAME CDATA DETAILEDSTATUS NAME HELP_STR_1 CDATA State of the current Export Debug Supp...

Page 36: ...M I T E M I D 0 x 0 0 2 D 2 5 C F I D V A L U E C D A T A 2 0 V A L U E N A M E C D A T A P E R C E N T C O M P L E T E N A M E H E L P _ S T R _ 1 C D A T A P r o g r e s s of the current Export Debug Support Data operation as a percent HELP_STR_1 HELP_STR_2 CDATA Item attribute min 0 max 100 step size 1 unit HELP_STR_2 ITEM RECORD TABLE HDR Client software is expected to poll the status by calli...

Page 37: ...eiver RF Input Status Command Table 14 Command Details Description Command Detail https 192 168 0 1 ws v2 status input Command URL Return information about RF input Command Information GET HTTP Method Read Access Type Guest User Admin Access Level GET https 192 168 0 1 ws v2 status input rf js 1 Syntax URI Parameters extension to the Command URL separated by N A Table 15 URI Query Set Arguments po...

Page 38: ... js Table 16 Output Field Descriptions Description Output Field Downlink Frequency Type Float Values 0 0 15 0 dnlkfreq Symbol Rate Type Float Values 1 0 45 0 symrate FEC Mode Type String Values Auto 1 2 2 3 3 4 5 6 7 8 8 9 fec Modulation Type Type String Values DVBS or DVB S2 mod Rolloff Factor Type String Values 20 25 35 Auto rolloff IQ Mode Type String Values Normal or Opposite iq Cisco D9800 Ne...

Page 39: ...e Float Values 0 0 15 0 xover Polarization Type String Values Horizontal Vertical Auto pol Orbital Position Type Float Values 0 0 360 0 orbpos East West Flag Type String Values N A East West ewflag AFC Range Value Type Float Values 0 0 5 0 afcrange PSI Acquisition Mode Type String Values Auto Basic Custom acqmode Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Referenc...

Page 40: ...Values No_Change DR Change User_Change Preset_Change Uplink_Change or NIT_TS_Change lsttunerea Last Tune Reason Type String Values Up to 24 characters tunereason Frequency Tuning Mode Type String Values NIT User Cfg freqmode Service List Mode S W Release 2 75 and up Type String Values Rigorous Relaxed Service List Mode Version 2 50 and earlier Type String Values Rigorous Degraded Note svclstmode C...

Page 41: ...values are for example purposes only input rf port 1 dnlkfreq 12 31003 symrate 30 0 fec 9 10 mod 8PSK DVB S2 rolloff 35 iq Normal pwr Off sel22khz Off lo1 10 75 lo2 0 0 xover 0 0 pol Horizontal orbpos 0 0 ewflag N A afcrange 3 0 acqmode Basic satlock No Lock inputrate 0 0 netname netid transid lsttunerea User_Change tunereason User freqmode NIT svclstmode Rigorous baten No niten Yes sdten Yes pate...

Page 42: ... dnlkfreq 12 31003 symrate 30 0 fec 9 10 mod 8PSK DVB S2 rolloff 35 iq Normal pwr Off sel22khz Off lo1 5 15 lo2 0 0 xover 0 0 pol Horizontal orbpos 0 0 ewflag N A afcrange 3 0 acqmode Basic 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 port 4 dnlkfreq 12 31003 symrate 30 0 fec 9 10 ...

Page 43: ... Command Table 17 Command Details Description Command Detail https 192 168 0 1 ws v2 status input asi Command URL Return information about ASI input Command Information GET HTTP Method Read Access Type Guest User Admin Access Level GET https 192 168 0 1 ws v2 status input asi js 1 Syntax URI Parameters extension to the Command URL separated by N A Cisco D9800 Network Transport Receiver Version 2 7...

Page 44: ...exist 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 js Table 19 Output Field Descriptions Description Output Field ASI Signal Lock Type String Values Lock or NoLock asilock Input Rate Type Integer Values 0 4294967295 inputrate Network Name Type String Values Up to 64 characters netname Network ID Type Integer...

Page 45: ... No_Change DR Change User_Change Preset_Change Uplink_Change or NIT_TS_Change lsttunerea Last Tune Reason Type String Values Up to 24 characters tunereason Frequency Tuning Mode Type String Values NIT User Cfg freqmode 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 svclstmode Cisco D9800 N...

Page 46: ...https 192 168 0 1 ws v2 status input asi js 1 Expected output values are for example purposes only input asi port 1 asilock NoLock inputrate 0 0 netname netid 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 REST...

Page 47: ... values preceded by and separated by Description URI Argument Multi Input Path Stream ID If not specified default value of 1 is used Type Integer Values 1 32 stream optional Format output using JSON standard Type exist 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 js Table 22 Output Field Description...

Page 48: ...lues Unk DES DVB BISS1 BISS2 or BISS3 scrambmode Transport Error Type String Values Ok Error or N A transerr IP Link Status Type String Values Down or Up iplinkstat IP Signal Type String Values None or Active ipsignal FEC Lock Type String Values None Column Row or Collision feclock PCR Lock Type String Values Yes or No pcrlock Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Service...

Page 49: ...ues Unk UDP or RTP data2tstyp Last Tune Reason Type String Values No_Change DR Change User_Change Preset_Change Uplink_Change or NIT_TS_Change lsttunerea Last Tune Reason Type String Values Up to 24 characters tunereason Frequency Tuning Mode Type String Values NIT User Cfg freqmode Service List Mode Version 2 75 and later Type String Values Rigorous Relaxed Service List Mode Version 2 50 and earl...

Page 50: ...s 1 Expected output values are for example purposes only input moip port 1 moiplock No Lock inputrate 0 0 netid transid scrambmode Unk transerr N A iplinkstat Down ipsignal None feclock None pcrlock No 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 Cisc...

Page 51: ... by Description URI Argument Multi Input Path Type Integer Values 1 32 stream key Format output using JSON standard Type exist 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 js Table 25 Output Field Descriptions Description Output Field Input is activated Type String Values Yes or No act ASI Signal Lo...

Page 52: ...alues 0 65535 netid Transport ID Type Integer Values 0 65535 transid Scrambling Mode Type String Values Unk DES DVB BISS1 BISS2 or BISS3 scrambmode Last Tune Reason Type String Values No_Change DR Change User_Change Preset_Change Uplink_Change or NIT_TS_Change lsttunerea Last Tune Reason Type String Values Up to 24 characters tunereason Frequency Tuning Mode Type String Values NIT User Cfg freqmod...

Page 53: ...ing Values Yes No sdten Enable PAT Reception Type String Values Yes No paten Bit rate of the input transport stream Type Float Values 0 4294 967295 Mbps rate Dowload bitrate of the input transport stream Type Float Values 0 4294 967295 Mbps dlrate Buffer level current queue 1 Type Float Values 0 4294 967295 Mb buflvlcurq1 Buffer level current queue 2 Type Float Values 0 4294 967295 Mb buflvlcurq2 ...

Page 54: ...lfragcnt Download fragment errors Type Integer Values 0 4294967295 dlfragerr Fragment parsing errors Type Integer Values 0 4294967295 fragerr Download stop time from the end of manifest Type Integer Values 0 4294967295 dlcurminlat Download start time from the beginning of manifest Type Integer Values 0 4294967295 dlcurtrglat Input Example curl k H X SESSION ID token https 192 168 0 1 ws v2 status ...

Page 55: ...ierr 0 dlfragcnt 0 dlfragerr 0 fragerr 0 dlcurminlat 0 dlcurtrglat 0 stream 2 act Yes abrlock No Lock iplinkstat Down ipsignal None inputrate 0 0 netname netid 113 transid scrambmode Unk lsttunerea User_Change tunereason User freqmode User Cfg svclstmode Relaxed baten N A niten N A sdten No paten No acqstatus Failed name ABR2 rate 0 dlrate 0 0 buflvlcurq1 0 0 buflvlcurq2 0 0 manidur 0 manierr 0 dl...

Page 56: ...xtension to the Command URL separated by N A Table 27 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Multi Input Path Type Integer Values 1 32 stream key Format output using JSON standard Type exist 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 XM...

Page 57: ...String Values None Active ipsignal Bit rate of the input transport stream Type Float Values 0 4294 967295 Mbps inputrate Network Name Type String Values Up to 64 characters netname Network ID Type Integer Values 0 65535 netid Transport ID Type Integer Values 0 65535 transid Scrambling Mode Type String Values Unk DES DVB BISS1 BISS2 or BISS3 scrambmode Cisco D9800 Network Transport Receiver Version...

Page 58: ...lues Rigorous Degraded svclstmode Enable BAT Reception Type String Values N A Yes No baten Enable NIT Reception Type String Values N A Yes No niten Enable SDT Reception Type String Values N A Yes No sdten Enable PAT Reception Type String Values N A Yes No paten Acquisition State Type String Values Full Partial None acqstatus Input Id Type String Values ZIXI1 ZIXI2 inputid Cisco D9800 Network Trans...

Page 59: ...ce currently connected Type String Values zixi tor02lab s 002 cisco com 2077 cisco BBB for example cursrc Example Input curl k H X SESSION ID token https 192 168 0 1 ws v2 status input zixi stream 1 js 1 Expected output values are for example purposes only input zixi stream 1 act Yes lock Lock Sig iplinkstat Up ipsignal Active inputrate 7 17246 netname netid transid 1 scrambmode Unk lsttunerea Use...

Page 60: ...thod Read Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status pe GET https 192 168 0 1 ws v2 status pe peid 2 or GET https 192 168 0 1 ws v2 status pe peid 2 chn chname Syntax Examples URI Parameters extension to the Command URL separated by N A Table 30 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Program Entry Identif...

Page 61: ... Field Channel Number to be configured on this Program Entry Type Integer Values 0 65535 Chn Channel Name Type String Values String used to describe the channel name less than 64 characters chname CA authorized Type String Values Yes No caauth CA Encrypted Type String Values Yes No caencrypt CA Scrambled Type String Values Yes No cascramble Cisco D9800 Network Transport Receiver Version 2 75 RESTf...

Page 62: ... DVN Holdings Shanghai ADT Shenzhen King Sky Dreamcrypt Thalescrypt Runcom Sidsa Beijing Com Latens Xcrypt Beijing Dig Widevine Tec SK Tel Enigma Sys Reserved Ruscrypt Other caid program status Type String Values Active Inactive prgmstatus PMT pid Type Integer Values 0 8192 pmtpid PCR pid Type Integer Values 0 8192 pcrpid SR Status Type String Values Not Started Primary Alternate srstatus SR Type ...

Page 63: ... caid prgmstatus Active prgmstatus pmtpid 5801 pmtpid pcrpid 2100 pcrpid srstatus Primary srstatus srtype None srtype srstartime 2007 09 01 00 00 00 srstartime srendtime 2007 09 01 00 00 00 srendtime peenabled Yes peenabled hdlicensed No hdlicensed chsource User chsource record pe Input request JSON output curl k H X SESSION ID token https 192 168 0 1 ws v2 status pe peid 1 js 1 Expected output va...

Page 64: ...68 0 1 ws v2 status ca pvu Display Details Syntax Details of Read ISE User Address Enc Data Pkts Passed Enc Data Pkts Rcvd Non Enc Data Pkts Pass Non Enc DataPkts Rcvd URI Parameters extension to the Command URL separated by N A Table 33 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Clear all counters clear Format output using JSON standar...

Page 65: ... are for example purposes only ca pvu iseuseradd 000 529 2431 6 iseuseradd encpktpass 10490 encpktpass encpktrcv 10490 encpktrcv nencpktpass 8390 nencpktpass nencpktrcv 8390 nencpktrcv iseuseradd 000 529 2432 3 iseuseradd encpktpass 10388 encpktpass encpktrcv 10388 encpktrcv nencpktpass 8392 nencpktpass nencpktrcv 8392 nencpktrcv pvu pvu Input Example request JSON format curl k H X SESSION ID toke...

Page 66: ...ttps 192 168 0 1 ws v2 status ca ci Display Details Syntax URI Parameters extension to the Command URL separated by N A Table 36 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument CI CAM Slot Type String Value TOP BOTTOM slot Format output using JSON standard Type exist Values any value or empty for example any of js 1 or js or js 0 or js 9999 ...

Page 67: ...ode CAM Manufacture Identifier Type Integer Value 0 0xFFFFFFFF mfgid CAM Serial Number Type String Value Inserted CAM Serial number in string format max 63 characters serialno CAM Hardware Version Type String Value Inserted CAM Hardware Version in string format hwver CAM Application Version Type String Value Inserted CAM Application Version in string format appver CAM Product Code Type Integer Val...

Page 68: ...amstatus Ready sysname Sony_MSM Professional CAM compname SMIT mfgcode 47806 mfgid 51966 serialno Unknown hwver Unknown appver Firmware 4 1 8 M App V12 May 30 2016 prodcode DVB CA Module CISYS Status Command Table 38 Command Details Description Command Detail https 192 168 0 1 ws v2 status ca cisys Command URL Return information about Common Interface CI CAMs supported System IDs Command Informati...

Page 69: ...e Type String Value CAM Supported System Name sysname CAM Supported System ID Type String Value Inserted CAM supported System IDs sysid CAM Supported System ID with Name Type String Value Inserted CAM supported System ID Name sysnameid Input example request XML format by default curl k H X SESSION ID token https 192 168 0 1 ws v2 status ca cisys Expected output values are for example purposes only...

Page 70: ... Restricted Access HTTP Methods Read Access Type Guest User Admin Access Level GET https 192 168 0 1 ws v2 status ca useraddr Display Details Syntax URI Parameters extension to the Command URL separated by N A Table 42 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Parameter Format output using JSON standard Type exist Values any value or empty for ...

Page 71: ...59 1 ca useraddr uaindex 1 uaindex useraddr 000 666 0462 4 useraddr useraddr ca Expected output values are for example purposes only ca useraddr uaindex 1 useraddr 000 666 0462 4 Output Status Command Table 44 Command Details Description Command Detail https 192 168 0 1 ws v2 status output Command URL This command can be used to get all output status parameters Command Information GET HTTP Method ...

Page 72: ...id inchan 1511 inchan type AUD type received Yes received pcr No pcr scrambled No scrambled pid pid peid 1 peid row 11 row inpid 1501 inpid outpid 1501 outpid inchan 1501 inchan type AUD type received Yes received pcr No pcr scrambled No scrambled pid pid peid 1 peid row 12 row inpid 1102 inpid outpid 1102 outpid inchan 1102 inchan type AUD type received Yes received pcr No pcr scrambled No scramb...

Page 73: ...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 moip output Input example request JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status output js 1 Expected output values are ...

Page 74: ... 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 pcr No scrambled No peid 1 row 10 inpid 1511 outpid 1511 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 RESTfu...

Page 75: ...led No collision status No Record in Dynamic Table moip enginerr No overflow No comrate 68 5 ts1rate 0 0 ts2rate 0 0 pid peid 1 row 1 inpid 1500 outpid 1500 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 peid 1 row 3 inpid 4001 outpid 4001 Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web...

Page 76: ...id 4004 inchan 4004 type MPE received No pcr No scrambled No peid 1 row 7 inpid 4005 outpid 4005 inchan 4005 type MPE received No pcr No scrambled No peid 1 row 8 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 pcr No scrambled No Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services...

Page 77: ...102 inchan 1102 type AUD received Yes pcr No scrambled No peid 1 row 13 inpid 1113 outpid 1113 inchan 1113 type AUD received Yes pcr No 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 65 API Definitions Out...

Page 78: ...Description URI Parameter ASI output status On NTC Basic or NTC MOIP supported values are asi or asi2 for the unique asi output On NTC MS supported values are asi1 for bidirectional port 1 and asi2 for bidirectional port 2 asi asi1 asi2 Table 48 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Parameter Format output using JSON standard Type exist Val...

Page 79: ...ee pid status No Record in Dynamic Table status pid collision status No Record in Dynamic Table status collision asi output Example on NTC MS unit in JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status output asi2 js 1 Expected output values are for example purposes only output asi2 rate 78 535695 free 0 0 pid peid 1 row 1 inpid 1500 outpid 1500 inchan 1500 type VID received No ...

Page 80: ... peid 1 row 6 inpid 4004 outpid 4004 inchan 4004 type MPE received Yes pcr No scrambled No peid 1 row 7 inpid 4005 outpid 4005 inchan 4005 type MPE received Yes pcr No scrambled No peid 1 row 8 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 W...

Page 81: ...2 outpid 1102 inchan 1102 type AUD received Yes pcr No scrambled No peid 1 row 13 inpid 1113 outpid 1113 inchan 1113 type AUD received Yes pcr No 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 69 API Defin...

Page 82: ...er MOIP output status On NTC Basic this call is not supported On NTC MOIP the supported values are moip or moip1 for the unique IP output On NTC multi stream unit the supported values are moip1 for IP output 1 and moip2 for IP output 2 moip moip1 moip2 Table 52 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Parameter Format output using JSON standar...

Page 83: ... token https 192 168 0 1 ws v2 status output moip Expected output values are for example purposes only 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 scra...

Page 84: ...d pid peid 1 peid row 2 row inpid 2110 inpid outpid 2110 outpid inchan 2110 inchan type AUD type received Yes received pcr No pcr scrambled Yes scrambled pid collision status No Record in Dynamic Table status collision moip1 output DPM PID Output Status Command Table 54 Command Details Description Command Detail https 192 168 0 1 ws v2 status output level_1 level_2 Command URL This command can be ...

Page 85: ...scription URI Level 1 Parameter Output type is ASI On NTC Basic or NTC MOIP the supported values are asi or asi2 for the unique asi output On NTC MS the supported values are asi1 for bidirectional port 1 and asi2 for bidirectional port 2 asi asi1 as2 Output type is MOIP On NTC Basic this call is not supported On NTC MOIP the supported values are moip or moip1 for the unique IP output On NTC MS the...

Page 86: ...ion Output Field Program Entry ID Type Integer Values 1 32 peid Key Identity of service in PMT Type Integer Values 1 64 row Key Input PMT Pid Type Integer Values 0 8191 inpid Output PMT Pid Type Integer Values 0 8191 outpid Stream Category Type String Values INVL PCR VID AUD SUBT VBI DPI MPE TTX DATA LSDT CDT ETV UNKN type Input Received Type Boolean Values Yes No received PCR Type Boolean Values ...

Page 87: ...ted output values are for example purposes only output asi pid status No Record in Dynamic Table ASI Example on NTC single stream unit for which ASI output was configured curl k H X SESSION ID token https 192 168 0 1 ws v2 status output asi pid js 1 Expected output values are for example purposes only output asi pid peid 1 row 1 inpid 2200 outpid 2200 type VID received Yes pcr No scrambled No peid...

Page 88: ... AUD received Yes pcr No scrambled No peid 1 row 3 inpid 18 outpid 18 type UNKN received No pcr No scrambled No ASI Example on NTC multi stream unit for which ASI2 output was configured curl k H X SESSION ID token https 192 168 0 1 ws v2 status output asi2 pid js 1 Expected output values are for example purposes only output asi2 pid peid 1 row 1 inpid 2200 outpid 2200 type VID received No pcr No s...

Page 89: ...utput moip1 pid peid 1 row 1 inpid 2200 outpid 2200 type VID received Yes pcr Yes scrambled No 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 pcr No scrambled No DPM Active Collisions Status Command Table 59 Command Details Description Command Detail https 192 168 0 1 ws v2 status output level_1 level_2 Command UR...

Page 90: ... output asi2 collision Syntax for getting ASI status output parameters Table 60 URI level_1 URI Parameters extension to the Command URL separated by Description URI Level 1 Parameter Output type is ASI On NTC Basic or NTC MOIP the supported values are asi or asi2 for the unique asi output On NTC MS the supported values are asi1 for bidirectional port 1 and asi2 for bidirectional port 2 asi asi1 as...

Page 91: ...iptions Description URI Level 2 Parameter Index Type Integer Values 0 65535 idx Key Conflict type Type String Values None Channel collision PMT PMT PID collision PMT ES PID collision ES ES PID collision Illegal Mode i PMT PID type PE index 1 Type Integer Values 1 32 peidx1 PMT Row 1 Type Integer Values 1 65 pmtrow1 PE index 2 Type Integer Values 1 32 peidx2 PMT Row 2 Type Integer Values 1 65 pmtro...

Page 92: ... unit for which MOIP output was configured curl k H X SESSION ID token https 192 168 0 1 ws v2 status output moip collision js 1 Expected output values are for example purposes only output moip collision status No Record in Dynamic Table ASI Example on NTC multi stream unit for which ASI1 output was configured curl k H X SESSION ID token https 192 168 0 1 ws v2 status output asi1 collision js 1 Ex...

Page 93: ...tion GET HTTP Method Read Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status decode video Syntax URI Parameters extension to the Command URL separated by N A Table 65 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Parameter Format output using JSON standard Type exist Values any value or empty for example any of js 1 or js or js ...

Page 94: ... B G I D PAL M PAL N AR NTSC sdoformat Bitrate in bps Type Integer Values 0 4294967295 bitrate 3 2 pulldown Type String Values Yes No or Recent pulldown32 Frames per second Type Integer Values 0 4294967295 frmpersec Synch mode Type String Values Auto Manual syncmode Encoding standard Type String Values MPEG1 MPEG2 H264 VC1 MPEG_P2 or Unknown encoding Example curl k H X SESSION ID token https 192 1...

Page 95: ...nsion to the Command URL separated by N A Table 68 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Audio Device Instance Type Integer Value 1 4 device Format output using JSON standard Type exist 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 js Table 69...

Page 96: ... eng lang Get all Audio Status in XML format example curl k H X SESSION ID token https 192 168 0 1 ws v2 status decode audio 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 mo...

Page 97: ...ls Description Command Detail https 192 168 0 1 ws v2 status decode audio st302 Command URL This command can be used to read all ST302 audio decode status Command Information GET HTTP Method Read Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status decode aud_st302 Syntax URI Parameters extension to the Command URL separated by N A Table 71 Output Field Descriptions Description O...

Page 98: ... 2x2 2x1 2 4x1 6x1 4 2 2 2 2x1 4x1 7 1 7 1 Screen PCM Bypass dolbyconfig Get Audio ST302 Status in JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status decode aud_st302 Expected output values are for example purposes only decode aud_st302 device 1 streamformat Unknown numstreams 0 packetsize Unknown dolbyconfig Unknown Closed Caption CC Decode Status Command Table 72 Command Deta...

Page 99: ...ON standard Type exist 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 js Table 74 Output Field Descriptions Description Output Field Actual Closed Caption Output Type String Value SA Custom EIA 708 Type 3 Type 4 SA Type 4 ATSC Reserved DVS 157 ccoutact Input example request default XML format curl k H X SESSIO...

Page 100: ...ecode output fields Note Command Information GET HTTP Method Read Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status decode vbi Syntax URI Parameters extension to the Command URL separated by N A Table 76 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Parameter Format output using JSON standard Type exist Values any value or empt...

Page 101: ...le purposes only decode vbi vitcstatus VITC SDI Decode Status Command Table 78 Command Details Description Command Detail https 192 168 0 1 ws v2 status decode level_1_parm Command URL This command is used to read all SDI global or SDI services decode status Partial response is not supported This command returns the status of all decode output fields for the specified level_1_parm SDI type Note Co...

Page 102: ...e valid Omitting this argument formats the output by default in XML js Table 81 Output Field Descriptions Description Output Field Indicates if video is interlaced Type String Values Yes or No interlaced Video frames per second Type Integer Values 0 4294967295 framessec Lines per video frame Type Integer Values 0 4294967295 lines VANC words per line Type Integer Values 0 4294967295 wordsline VANC ...

Page 103: ...P47 serviceid Service is being output Type String Values Yes or No active Line number where VANC service is expected Type Integer Values 0 4294967295 adjline Line number where VANC service is located in top field or frame Type Integer Values 0 4294967295 topline Line number where VANC service is located in bottom field Type Integer Values 0 4294967295 bottomline Maximum number of lines used by VAN...

Page 104: ...mple purposes only decode sdiglb interlaced No framessec 0 0 lines 0 wordsline 0 firstline 0 lastline 0 switchline 0 multiline No Request SDI Services status with result in JSON format example curl k H X SESSION ID token https 192 168 0 1 ws v2 status decode sdisvc Expected output values are for example purposes only decode sdisvc serviceid EIA 708 active No adjline 2 topline 0 bottomline 0 maxlin...

Page 105: ...t 0 avgdroppkt 0 serviceid MULTI OP47 active No adjline 6 topline 0 bottomline 0 maxlines 0 avgdata 0 avgtranpkt 0 avgdroppkt 0 HDMI Decode Status Command Table 83 Command Details Description Command Detail https 192 168 0 1 ws v2 status decode hdmi Command URL This command is used to read all or single device HDMI decode status Command Information GET HTTP Method Read Access Type Cisco D9800 Netw...

Page 106: ...ype exist 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 js Table 85 Output Field Description Description Output Field HDMI device instance number Type integer Values 1 2 hdmiindex HDMI output connected to monitor Type String Values Yes No connected HDMI device powered Type String Values Yes No powere...

Page 107: ...Value Unknown SMPTE 2084 HDR SDR eotf Input example request JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status decode hdmi js 1 Expected output values are for example purposes only decode hdmi hdmiindex 1 connected No powered No monitorname Unknown colorspace Unknown colordepth Unknown colorrange Unknown matrixcoeff Unknown eotf Unknown hdmiindex 2 connected No powered No monit...

Page 108: ...ils Description Command Detail https 192 168 0 1 ws v2 status identity Command URL This command is used to read all identity details Partial response is not supported This command simultaneously returns the status of all identity details output fields Note Command Information GET HTTP Method Read Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status identity Syntax URI Parameters ...

Page 109: ...e Maximum of 13 characters trackingid Master user address Type String Value Maximum of 15 characters masterua Ethernet control port MAC address Type String Value Maximum of 18 characters format 00 00 00 00 00 00 CtlMacAddr hwoptions MPEG Over IP Output Supported Type String Value Yes if No then element will not be output mpoipout MPEG Over IP Input Supported Type String Value Yes if No then elemen...

Page 110: ...tring Value 1 N if 0 then element will not be output HEVC Transcode License Count Number of tuner licenses Type String Value 1 N if 0 then element will not be output Tuner License Count Licensed for decryption Type String Value Yes if No then element will not be output Decrypt License Licensed for DVB S2 Type String Value Yes if No then element will not be output DVB_S2 License Licensed for tuner ...

Page 111: ...above but only show what is in the original license file s For example default licenses have not been added Also the element tag is as it appears in the license file The field returned is maximum of 8 characters regardless of whether or not it represents a numeric value Note Number of HD transcode licenses Type String Value 1 N if 0 then element will not be output HD_Transcode Number of SD transco...

Page 112: ...not be output HEVC_Decode Licensed for HD output Type String Value 1 if 0 then element will not be output HD_Output Licensed for full HD output Type String Value 1 if 0 then element will not be output Full_HD_Output Licensed for UHD output Type String Value 1 if 0 then element will not be output UHD_Output Licensed for audio 3 and 4 output Type String Value 1 if 0 then element will not be output A...

Page 113: ...enabled 1 enabled feature HD_Output feature enabled 1 enabled feature Full_HD_Output feature enabled 1 enabled featur e AUD3_4 feature enabled 1 enabled licensefile ident Input request JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status identity js 1 Expected output values are for example purposes only ident hostname User cfg name trackingid 456JK123YX masterua 123 123 4567 1 ct...

Page 114: ...t GET https 192 168 0 1 ws v2 status device power GET https 192 168 0 1 ws v2 status device about POST https 192 168 0 1 ws v2 status device about clear Syntax Table 90 URI level_1_extension Parameters extension to the Command URL separated by Description URI Parameter Reads and returns current value of all device categories and related items None Reads and returns current value of ECC specific de...

Page 115: ...out the liferstclr counter Command Information GET POST see Syntax row HTTP Methods Read Write for POST operation only Access Type User Admin Access Level GET https 192 168 0 1 ws v2 status device about or POST https 192 168 0 1 ws v2 status device about clear Syntax Table 93 URI Parameters extension to the Command URL separated by Description URI Parameter Read all when no Arguments uncategorized...

Page 116: ...s the output by default in XML js Table 95 Output Field Descriptions Description Output Field Model number Type String Value Maximum of 50 characters modelnum Model name Type String Value Maximum of 50 characters modelname Catalogue number Type String Value Maximum of 50 characters catalognum Board ID Type String Value Maximum of 50 characters boardid Board revision Type String Value Maximum of 50...

Page 117: ...imum of 100 characters copyright Production date and time Type String Values string format yyyy mm dd hh mm ss proddate Last power on date and time Type String Values string format yyyy mm dd hh mm ss pwrupdate Lifetime number of hours powered on Type Integer Values 0 N lifepower Lifetime number of resets Type Integer Values 0 N lifereset Clearable count of number of resets Type Integer Values 0 N...

Page 118: ... GNU General Public License version 3 provided with ABSOLUTELY NO WARRANTY under the terms of GNU General Public License Version 3 available here http www gnu org licenses gpl html about4 br GNU General Public License version 2 provided with ABSOLUTELY NO WARRANTY under the terms of GNU General Public License version 2 available here http www gnu org licenses old licenses gpl 2 0 html about5 br GN...

Page 119: ...example purposes only xml version 1 0 encoding ISO 8859 1 response code 10 code result success result message message response ECC Status Command Table 96 Command Details Description Command Detail https 192 168 0 1 ws v2 status device ecc Command URL Return status of ecc environmental characteristics and control items Command Information GET HTTP Method Read Access Type User Admin Access Level GE...

Page 120: ...ices are already known Type Integer Values 0 slot Mandatory when row is specified This is a key field for filtering output fields to a specified row See description under slot Type Integer Values 0 row Mandatory when slot is specified 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 ...

Page 121: ...displayItemName type Temperature type value 26 C value cardslot cardslot displayOrderFlag 0 displayOrderFlag ecc ecc slot 0 slot row 3 row card NBP card displayBoardName System displayBoardName location power fan location displayItemName PSU Fan displayItemName type Fan Status Speed type value 11428 RPM value cardslot NBP0 cardslot displayOrderFlag 255 displayOrderFlag ecc ecc slot 0 slot row 4 ro...

Page 122: ... displayBoardName location 1 0V location displayItemName 1 0V displayItemName type Voltage type value 0 98 V value cardslot NTC0 cardslot displayOrderFlag 1 displayOrderFlag ecc ecc slot 0 slot row 18 row card NTC card displayBoardName Controller displayBoardName location 5 0V location displayItemName 5 0V displayItemName type Voltage type value 5 07 V value cardslot NTC0 cardslot displayOrderFlag...

Page 123: ... displayItemName 1 5V displayItemName type Voltage type value 1 50 V value cardslot NDM2 cardslot displayOrderFlag 3 displayOrderFlag ecc ecc slot 2 slot row 8 row card NDM card displayBoardName Decoder displayBoardName location 5 0V location displayItemName 5 0V displayItemName type Voltage type value 4 98 V value cardslot NDM2 cardslot displayOrderFlag 3 displayOrderFlag ecc ecc slot 2 slot row ...

Page 124: ...e 1 added As a result the Management Port is port1 DATA1 is port2 and DATA2 is port3 Command Information GET HTTP Method Read Access Type Guest User Admin Access Level GET https 192 168 0 1 ws v2 status device eth Syntax URI Parameters extension to the Command URL separated by N A Table 100 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Thi...

Page 125: ...ESSION ID token https 192 168 0 1 ws v2 status device eth Expected output values are for example purposes only xml version 1 0 encoding ISO 8859 1 device eth port 1 port link Link Up link speed 1 Gbps speed duplex Full duplex xover N A xover eth eth port 2 port link Link Down link speed N A speed duplex N A duplex xover N A xover eth eth port 3 port link Link Down link speed N A speed duplex N A d...

Page 126: ...separated by N A The following table lists the URI argument Table 103 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Slot number within the chassis Type Integer Value 0 to number of slots in chassis 1 slot 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 f...

Page 127: ... by the software at target initialization time displayBoardName Status of slot check on power up Type Boolean Value Ok or Fault status Input example request output in JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status device power js 1 Expected output values are for example purposes only device power slot 0 good Yes displayBoardName Controller status Ok slot 1 good Yes displayB...

Page 128: ...lot 1 good Yes displayBoardName Tuner status Ok Alarms and Warnings This section describes the status commands related to alarms and warnings Fault Details Status Command Table 105 Command Details Description Command Detail https 192 168 0 1 ws v2 status faults Command URL Returns all faults status details information Command Information GET HTTP Method Read Access Type User Admin Access Level GET...

Page 129: ...ctwarns 6 clrfaults 332 status type Warning name TDT warning details RF1 TDT is lost setsince 2017 03 21 22 26 06 history name System Startup type Alarm details Auto reset after timeout setdatetim 2016 12 19 17 33 46 rstdatetim 2016 12 19 17 33 47 state Clear name Signal Status type Alarm details Signal is locked setdatetim 2036 11 21 14 27 04 rstdatetim 2036 11 21 14 27 10 state Clear name FPGATe...

Page 130: ...atus faults actions clrhistory Syntax URI Parameters extension to the Command URL separated by N A Table 108 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument 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 js optional Ta...

Page 131: ... message message response Input example Clear Fault History curl k X POST H Accept application json H X SESSION ID token https 192 168 0 1 ws v2 status faults actions clrhistory Expected output values are for example purposes only xml version 1 0 encoding ISO 8859 1 response code 10 code result success result message message response Faults Summary Status Command Table 110 Command Details Descript...

Page 132: ...e Integer Value 0 4294967295 clrfaults Input example read back all faults summary in default XML format curl k H X SESSION ID token https 192 168 0 1 ws v2 status summary Expected output values are for example purposes only xml version 1 0 encoding ISO 8859 1 faults summary actalarms 1 actalarms actwarns 3 actwarns clrfaults 144 clrfaults summary faults Input example read back all faults summary i...

Page 133: ...ds and values preceded by and separated by Description URI Argument 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 js optional Table 115 Output Field Descriptions Description Output Field Fault Type Type String Value Alarm Warning Type Fault name Type String Value Maximum of...

Page 134: ...PMT is lost details setsince 2017 03 21 22 25 36 setsince status status type Warning type name PAT warning name details RF1 PAT is lost details setsince 2017 03 21 22 25 36 setsince status faults Input example read back faults status in JSON format curl k H X SESSION ID token https 192 168 0 1 ws v2 status faults status js 1 Expected output values are for example purposes only faults status type W...

Page 135: ...r Admin Access Level GET https 192 168 0 1 ws v2 status faults history Syntax URI Parameters extension to the Command URL separated by N A Table 117 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument 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...

Page 136: ... state Input example Read back faults history in default XML format curl k H X SESSION ID token https 192 168 0 1 ws v2 status faults history Expected output values are for example purposes only faults history record type Alarm type name Signal Status name details ASI Signal No Content details setdatetim 2010 11 12 23 55 34 setdatetim rstdatetim 2010 11 12 23 51 58 rstdatetim record record type Al...

Page 137: ...7 48 23 rstdatetim 2016 12 24 07 48 24 state Clear name System Startup type Alarm details Auto reset after timeout setdatetim 2016 12 24 09 21 32 rstdatetim 2016 12 24 09 21 33 state Clear name System Startup type Alarm details Auto reset after timeout setdatetim 2016 12 24 09 21 31 rstdatetim 2016 12 24 09 21 32 state Clear Disaster Recovery D R Status Command Table 119 Command Details Descriptio...

Page 138: ...one Reads and returns current value of D R global status global Reads and returns current value of D R backup tuning tuning Reads and returns current value of D R backup channels channels Reads and returns current value of D R origin tuning origtuning Reads and returns current value of D R origin channels origchans Table 121 URI Query Set Arguments possible fields and values preceded by and separa...

Page 139: ...xtension to the Command URL separated by N A Table 123 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument DR Status Type String Value D R in progress No Disaster D R Ready D R disabled Maintenance Mode NIT Retune Recovery in progress status DR Signal Lock Timeout Value Type Integer Value 5 255 siglock DR Signal Loss Timeout Vaule Type Integer V...

Page 140: ...ill look dr global status No Disaster D R Ready siglost 120 siglock 40 verify 60 cfgsource User Disaster Recover D R Backup Tuning Status Command Table 124 Command Details Description Command Detail https 192 168 0 1 ws v2 status dr tuning Command URL Get of D R backup tuning status Command Information GET HTTP Method Read Access Type User Admin Access Level All D R backup tuning status GET https ...

Page 141: ...ype Integer Values 0 65535 netid D R backup tuning Frequency GHz Type Float Values 0 0 15 0 dnlkfreq D R backup tuning RF symbol rate Type Float Values 1 0 45 0 symrate D R backup tuning RF modulation system Type String Values for example QPSK DVB S mod D R backup tuning FEC Mode Type String Values Auto 1 2 2 3 3 4 5 6 7 8 8 9 fec D R backup tuning RF rolloff Type String Values 20 25 35 Auto rollo...

Page 142: ...ed the session ID and set it to a variable token In addition it is assumed that the IP of the unit is 192 168 0 1 Change the IP address 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 status dr tuning csirec 1 If successful the return body will look dr tuning csirec 1 fec AUTO ewflag N A dnlkfreq 3 53 input RF2 mod QPSK DVB S net...

Page 143: ...hannels peid PE1 csirec 1 bkpchan Syntax URI Parameters extension to the Command URL separated by N A Table 127 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument D R backup channel Program Entry ID Type String Values PE1 PE16 peid Key Record index of D R backup Transport Type Integer Values 1 16 csirec Key D R backup channel number Type Intege...

Page 144: ...pchan 201 rowstatus Yes Disaster Recovery D R Origin Tuning Status Command Table 128 Command Details Description Command Detail https 192 168 0 1 ws v2 status dr origtuning Command URL Get of D R origin tuning Command Information GET HTTP Method Read Access Type User Admin Access Level All D R origin tuning status GET https 192 168 0 1 ws v2 status dr origtuning Syntax URI Parameters extension to ...

Page 145: ...ng FEC Mode Type String Values Auto 1 2 2 3 3 4 5 6 7 8 8 9 fec D R origin tuning RF rolloff Type String Values 20 25 35 Auto rolloff DR West East Flag Type String Values N A East West ewflag DR Orbital Position Deg Type Float Values 0 0 360 0 orbpos DR Orbital Polarization Type String Values Horiz Vert Circ_l Circ_r Auto pol GET Examples Example 1 Retrieve D R Orign tuning Cisco D9800 Network Tra...

Page 146: ... Details Description Command Detail https 192 168 0 1 ws v2 status dr origchans Command URL Allows get of D R origin channel status Command Information GET HTTP Method Read Access Type User Admin Access Level All D R origin channels Status GET https 192 168 0 1 ws v2 status dr origchans Single D R origin channels status for example GET https 192 168 0 1 ws v2 status dr origchans peid PE1 origchan ...

Page 147: ...92 168 0 1 ws v2 status dr origchans peid PE1 origchan If successful the return body will be dr origchans peid PE1 origchan 101 Configuration API This section lists all the configuration commands Input Configuration Command Table 132 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg input Command URL Allows inputs to be read or configured Command Information GET POST H...

Page 148: ...o this command POST Settings Write Examples Input with invalid setting Setting Parameters using XML body data from command line curl k X POST H X SESSION ID token header Content type application xml d input rf port 1 port act Yes act dnlkfreq 3 40 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 onl...

Page 149: ...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 ewfla...

Page 150: ...plementations pass the full URL string through a safe url character converter before issuing the command Note For more information about safe URL encoding see http www ietf org rfc rfc2396 txt or http www skorks com 2010 05 what every developer should know about urls RF Input Configuration Command Table 134 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg input rf Com...

Page 151: ...Description URI Argument Input Port to be configured Type Integer Values 1 16 range as shown below NFE1 1 4 NFE2 5 8 NFE3 9 12 8 NFE4 12 16 8 This does not refer to the NTC Ethernet ports it refers specifically to the RF ports Note port Key Multi Input Stream ID If not specified default value of 1 is used Type Integer Values 1 6 RF stream Key optional This is not applicable to Version 1 x Activate...

Page 152: ...posite Normal Auto Iq LNB Power Type String Values Off 13V 18V H NIT V NIT pwr 22 KHz Selection Type String Values Off On Auto sel22khz LO Select 1 Type Float Values 0 0 15 0 lo1 LO Select 2 Type Float Values 0 0 15 0 lo2 Cross Over Frequency Type Float Values 0 0 15 0 xover Polarization Type String Values Horizontal Vertical Auto pol Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web...

Page 153: ...ect Stream 3 Type String Values Yes or No strm3sel This is not applicable to Version 1 x Select Stream 4 Type String Values Yes or No strm4sel This is not applicable to Version 1 x Select Stream 5 Type String Values Yes or No strm5sel This is not applicable to Version 1 x Select Stream 6 Type String Values Yes or No strm6sel This is not applicable to Version 1 x PSI Acquisition Mode Type String Va...

Page 154: ...ut Fields Output fields returned in GET results are the same names used for the possible Arguments for this command POST Examples Example 1 Changing one RF Tuning Parameter 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 Please change the IP to...

Page 155: ...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 Please change the IP to the specific unit IP in use This example retrieves all of the RF tuning settings for RF port 3 Please note that the user MUST always specify the port number in the URI curl...

Page 156: ... example retrieves multiple parameter value from the RF tuning settings for RF port 3 Please note that the user MUST always specify the port number in the URI followed by the URI arguments the user wishes to retrieve This example retrieves the iq sdten niten and paten values from RF Port 3 Please note that in GET URI s only the port argument must contain a value for the port all other arguments DO...

Page 157: ...2 mod DVB S Expected Output xml version 1 0 encoding ISO 8859 1 response code 10 code result success result message message response ASI Input Configuration Command Table 136 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg input asi Command URL Allows ASI tuning input settings to be read or configured Command Information GET POST HTTP Methods Read Write with complex ...

Page 158: ...put Port to be configured Type Integer Value 2 This does not refer to the NTC Ethernet ports it refers specifically to the ASI ports Note port Key Multi Input Stream ID If not specified default value of 1 is used Type Integer Value 2 stream Key optional This is not applicable to Version 1 x Activate Input Type String Values Yes or No act PSI Acquisition Mode Type String Values Auto Basic Custom ac...

Page 159: ...fully 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 change the IP to the specific unit IP in use This example changes the acqmode of ASI port 1 to Auto curl X POST 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 Auto If successful...

Page 160: ...8 0 1 ws v2 service_cfg input asi port 1 If successful the return body will be input asi port 1 act No acqmode Auto netid 1 freqmode NIT svclstmode Rigorous niten No sdten Yes paten Yes Example 4 GET a specific ASI tuning value for a specific ASI port 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 additi...

Page 161: ...d paten values from ASI Port 1 Note In GET URIs only the port argument must contain a value for the port all other arguments DO NOT contain values Note 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 sdten acqmode paten niten If successful the return body will be input asi port 1 acqmode Auto niten No paten Yes sdten Yes MOIP Input...

Page 162: ...specified For POST the stream must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following the table Note Table 139 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Multi Input Path Stream ID Type Integer Values 1 32 stream Key Mandatory Act...

Page 163: ...P address in the dot format for example 192 131 244 10 usrsrcaddr Source IP address filtering mode Type String Values None White List Black List srcfltmode Dejitter Algorithm Type String Values CBR or VBR dejalg Redundancy Trigger on Audio Video Loss Type String Values Yes No avlostrig Redundancy Trigger on PCR Loss Type String Values Yes No pcrlostrig Redundancy Trigger on PMT Loss Type String Va...

Page 164: ...es 0 65535 netid Frequency tuning mode Type String Values NIT User Cfg freqmode Service List Mode Version 2 75 and later Degraded is only available as a Write POST option It is the same as Relaxed Note Type String Values Rigorous Relaxed Service List Mode Version 2 50 and earlier Type String Values Rigorous Degraded svclstmode Enable NIT reception Type String Values Yes No niten Cisco D9800 Networ...

Page 165: ...tive Revertive reddir Direct Redundancy Switch Over Delay in milliseconds Type Integer Values 0 10000 reddel Revertive Redundancy Switch Over Delay in seconds Type Integer Values 0 30 redrev Add or Delete an instance of IP Input Type String Values Add R W Delete R W Active RO Inactive RO cmdrow Output Fields Output fields returned in GET results are the same names used for the possible arguments f...

Page 166: ...plication json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg input moip stream 1 paten Yes sdten Yes freqmode NIT niten No If successful the return body will be response code 10 result success message GET Examples Example 3 GET the full MOIP tuning values for a specific MOIP stream The following example assumes that the user has successfully logged onto the unit received the session i...

Page 167: ...Example 5 GET multiple MOIP tuning value for a specific MOIP stream 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 change the IP to the specific unit IP in use This example retrieves multiple parameter value from the MOIP tuning setti...

Page 168: ...RI Parameters extension to the Command URL separated by N A All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values except the idx which must be specified For POST the idx must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following the table Not...

Page 169: ...age GET Examples Example 2 Get full table of MOIP Source Filters 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 change the IP to the specific unit IP in use This example returns the full MOIP source filters for every index curl X GET ...

Page 170: ...input moip srcselect Command URL Allows MOIP source select settings to be read or configured Command Information GET POST HTTP Methods Read Write with complex input data Access Type User Admin Access Level 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 GET Syntax POST https 192 168 0 1 ws v2 servi...

Page 171: ...ring Value Yes No data1sel IP is present in the DATA1 stream Type String Value Yes No data1avail Allow DATA1 to be selected or not Type String Value Yes No data1Enabled DATA2 selection state DATA2 is either selected or not selected Type String Value Yes No data2sel IP is present in the DATA2 stream Type String Value Yes No data2avail Allow DATA2 to be selected or not Type String Value Yes No data2...

Page 172: ... data4avail Allow DATA4 to be selected or not Type String Value Yes No data4Enabled Table 144 URI Set Arguments possible fields and values preceded by and separated by Description URI Argument Stream ID Type Integer Values 1 32 stream Key Set the IP address to lock from DATA1 Type String Value IP address in the dot format for example 192 168 0 1 dat1srcaddr Set the IP address to lock from DATA2 Ty...

Page 173: ...caddr 10 10 10 10 dat2srcaddr 10 10 10 11 If successful the return body will be response code 10 result success message GET Examples Example 2 Get the MOIP Source Select Configuration This example returns the MOIP source select configuration for stream 1 index 1 curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg input moip srcselect streamid 1 idx 1 I...

Page 174: ...sing command line arguments are limited to maximum of 26 arguments after the Note All of the URI Arguments in the table apply to both GET and POST For GET the URI arguments do not need any values except the stream which must be specified For POST the stream must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be...

Page 175: ...T Reception Type String Values NIT User Cfg freqmode Service List Mode Version 2 75 and later Degraded is only available as a Write POST option for backwards compatibility It is the same as Relaxed Note Type String Values Rigorous Relaxed Service List Mode Version 2 50 and earlier Type String Values Rigorous Degraded svclstmode Enable BAT Reception Type String Values Yes No baten Enable NIT Recept...

Page 176: ... Values Add R W Delete R W Active RO Inactive RO cmdrow ABR settings minimum latency Type Integer Values 0 4294967295 minlatency Output Fields Output fields returned in GET results are the same names used for the possible Arguments for this command POST Examples Example 1 Changing one ABR Parameter The following example assumes that the user has successfully logged onto the unit received the sessi...

Page 177: ...specific ABR entry 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 change the IP to the specific unit IP in use The following example retrieves all of the ABR settings for stream 2 curl X GET i H Accept application json H X SESSION ID ...

Page 178: ...tings This example retrieves the camode sdten niten and paten values from ABR stream 2 In GET URI s only the entry selection argument stream must contain a value all other arguments DO NOT contain values Note curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg input abr stream 2 camode sdten paten niten js 1 If successful the return body will be input ...

Page 179: ...owed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following the table Note Table 148 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Multi Input Stream ID Type Integer Values 1 32 stream Key Activate Input Type String Values Yes or No act Network Identifier Typ...

Page 180: ...s Relaxed Service List Mode Version 2 50 and earlier Type String Values Rigorous Degraded svclstmode Enable BAT Reception Type String Values Yes No baten Enable NIT Reception Type String Values Yes No niten Enable SDT Reception Type String Values Yes No sdten Enable PAT Reception Type String Values Yes No paten ZIXI settings name Type String Value Up to 12 characters Name RO Cisco D9800 Network Tr...

Page 181: ...or Delete an instance of ZIXI Input Type String Values Add R W Delete R W Active RO Inactive RO rowstatus ZIXI input stream latency Type Integer Values 0 4294967295 latency Descrambling key for ZIXI Input Stream Type String Value Up to 64 characters decrkey Redundancy Mode Type String Values Yes No redmode Redundancy Backup ZIXI input source such as a URL Type String Value Up to 200 characters red...

Page 182: ...ror Correction Overhead Type Integer Values 0 10000 fecovhd Forward Error Correction Block Type Integer Values 0 10000 fecblkms Forward Error Correction Content Aware Type String Values Yes No fecconawar Forward Error Correction Maximum Jitter Type Integer Values 0 10000 fecmaxjitr Forward Error Correction Stuff Null Type String Values Yes No fecstufnul Latency Mode Type String Values Static Incre...

Page 183: ... Example 2 Changing multiple ZIXI Parameters This example changes several ZIXI parameters for an existing entry It will set the netid to 12345 sdten to Yes paten to Yes and niten to Yes curl X POST i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg input zixi stream 2 netid 12345 sdten Yes paten Yes niten Yes If successful the return body will be response code 1...

Page 184: ...168 0 1 ws v2 service_cfg input zixi stream 1 camode js 1 If successful the return body will be input zixi stream 1 camode Std Example 5 GET multiple ZIXI tuning value for a specific ZIXI stream This example retrieves multiple parameter values from the ZIXI settings This example retrieves the camode sdten niten and paten values from ZIXI stream 1 In GET URIs only the entry selection argument strea...

Page 185: ...pecify the peid argument and value For POST specify the peid argument and value and the chn argument followed by the associated value the user would like to map Muliple peids may be mapped by using the input file syntax for POST command In depth CURL examples can be seen below following the table Table 150 URI Query Set Arguments possible fields and values preceded by and separated by Description ...

Page 186: ...e 151 Output Field Descriptions Description Output Field Program Entry Identifier Type Integer Value 1 32 peid Channel Number to be configured on this Program Entry Type Integer Values 0 65535 chn Input port name Type String Values Single Stream target RF1 RF4 MOIP ASI Multi Stream target RF1 RF4 MOIP1 MOIP2 ASI1 ASI2 inp GET Method Examples Use to display PE information in the format of XML or JS...

Page 187: ...n 0 chn inp inp record record peid 24 peid chn 0 chn inp inp record record peid 25 peid chn 0 chn inp inp record record peid 26 peid chn 0 chn inp inp record record peid 27 peid chn 0 chn inp inp record record peid 28 peid chn 0 chn inp inp record record peid 29 peid chn 0 chn inp inp record record peid 30 peid chn 0 chn inp inp record record peid 31 peid chn 0 chn inp inp record record peid 32 pe...

Page 188: ...of temp js pe record peid 1 chn 802 Input POST PE configuration info via file temp js curl k X POST H X SESSION ID token header Content Type application json d C projects temp js https 192 168 0 1 ws v2 service_cfg pe js 1 Expected output values are for example purposes only response code 10 result success message To POST a channel change to a specific PE in this case PE 1 and new channel will be ...

Page 189: ...Parameters extension to the Command URL separated by N A Table 153 XML JSON file input arguments and Output Fields Description Port Name Type String Valid output port names for Phase 1 single stream units only asi moip Type String Valid output port names for multi stream units asi1 asi2 moip1 moip2 Table 154 ASI ASI1 or ASI2 Next level names after Port Name Description ASI ASI1 or ASI2 Next Level ...

Page 190: ...owed with ratemode User insertnul Program Entry Identifier Type String XML JSON Format Value PE1 PE32 P1A P16A Command Line Input Value 1 32 Multistream 1 16 Phase I Single Stream peid pe PE Action Type String Values Drop Pass Map XCode action Output PMT PID Type Integer Values 0 8191 pmtpid Output Channel Number Type Integer Values 0 65535 outchan Cisco D9800 Network Transport Receiver Version 2 ...

Page 191: ... Type String Values Yes No insertnul No is not allowed with ratemode User insertnul Set valid SAP destination IP address multicast only Type String Value IP address in dot format for example 224 2 127 254 mcastip Set the SAP UDP destination port number Type Integer Value 1024 65534 destport FEC arrangement Block aligned 0 or Non Block aligned Type String Values Block Aligned Non Block Aligned fecs...

Page 192: ... Delay before switching from Backup to Main port in sec Type Integer Value 0 120 redundelbck 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 peid pe PE Action Type String Values Drop Pass Map XCode action Output PMT PID Type Integer Values 0 8191 pmtpid Output Channel Number Type Integer Values 0 65535 outch...

Page 193: ...caps Destination IP Address Type String Values IP address in the dot format for example 192 168 0 1 dest_ip Destination IP Port Type Integer Values 1 65534 dest_port Traffic Class Type Integer Values 0 255 toc Time To Live Type Integer Values 0 255 ttl Source UDP Port Type Integer Values 0 65534 src_port 0 means use default UDP port src_port Announce Type Type String Values None RFC 2327 ann_type ...

Page 194: ...e Type String Values None 1D 2D fec_mode Fec Columns Depth Type Integer Values 1 20 fec_col Fec Rows Depth Type Integer Values 4 20 fec_row FEC Columns UDP Port Type Integer Values 1 65534 fec_colport FEC Rows UDP Port Type Integer Values 1 65534 fec_rowport Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web Services API Reference Guide 182 API Definitions Output Configuration Command...

Page 195: ...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 ...

Page 196: ...g ISO 8859 1 response code 10 code result success result message message response Setting Parameters using body data from XML File for single stream unit shown curl k X POST H X SESSION ID token header Content type application xml d C projects output xml https 192 168 0 1 ws v2 service_cfg output Output File output xml contains data as shown below output asi mode Pass mode dscrmode Scramble dscrmo...

Page 197: ...tput xml https 192 168 0 1 ws v2 service_cfg output asi1 mode mode POST Syntax URI Parameters extension to the Command URL separated by N A All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values For POST any of the below URI arguments can be supplied with their associated value the user would like to set In depth CURL examples can be seen below f...

Page 198: ... PIDs resync Format output using JSON standard applies to command line input only 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 js For resync operation only HTTP data body is supported POST from XML JSON file is not supported As noted in Get on page 3 in the URL input the space in STRING should be replaced ...

Page 199: ...it is 192 168 0 1 You must change the IP to the specific unit IP in use This example returns the full ASI Output settings 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 If successful the return body will be please note this is a snippet of the full return body output asi mode No Output dscrmode Descrambled ratemode User rate 68 5 insert...

Page 200: ...tps 192 168 0 1 ws v2 service_cfg output moip1 Multi stream unit moip output port 1 https 192 168 0 1 ws v2 service_cfg output moip1 Multi stream unit moip output port 2 https 192 168 0 1 ws v2 service_cfg output moip2 Command URL Allows set or get of MOIP output parameters Command Information GET POST HTTP Methods Read Write Access Type User Admin Access Level One of the following GET https 192 1...

Page 201: ...guments can be supplied with their associated value the user would like to set In depth CURL examples can be seen below following the table Note Table 161 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Output Mode Type String Values No Output Passthrough Service Channels Only Map Passthrough Map Service Channels Only Full DPM Control Transc...

Page 202: ...d fecscheme Set the number of transport packets to be sent per IP packet Type Integer Value 1 7 tpperframe Redundancy Mode Type String Values Mirroring Backup First Port Backup Second Port Manual First Port Manual Second Port redunmode Switchover direction Type String Values Non Revertive or Revertive redundir Delay before switching from Main to Backup port in ms Type Integer Value 0 10000 redunde...

Page 203: ...ing 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 change the IP to the specific unit IP in use This example changes both the output descrambling mode to Descrambled and the ratemode to User curl X POST i H Accept application json H X SESSION ID to...

Page 204: ...S unit curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg output moip1 Example 3 Get specific MOIP Output Settings 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 change the IP to the spec...

Page 205: ... 0 1 ws v2 service_cfg output moip pe or https 192 168 0 1 ws v2 service_cfg output moip1 pe Multi stream asi or moip output port 1 https 192 168 0 1 ws v2 service_cfg output asi1 pe https 192 168 0 1 ws v2 service_cfg output moip1 pe Multi stream unit asi or moip output port 2 https 192 168 0 1 ws v2 service_cfg output asi2 pe https 192 168 0 1 ws v2 service_cfg output moip2 pe Command URL Allows...

Page 206: ...ervice_cfg output asi1 pe peid peid mode mode POST https 192 168 0 1 ws v2 service_cfg output moip1 pe peid peid mode mode POST Syntax Setting Parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values e...

Page 207: ...a specific PE 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 change the IP to the specific unit IP in use This example changes both the PE action to Pass and Output Channel Number to 105 The asi pe peid VAL must be provided before add...

Page 208: ... 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 change the IP to the specific unit IP in use This example returns 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 If successful the r...

Page 209: ...po Multi stream unit moip output port pair 3 4 https 192 168 0 1 ws v2 service_cfg output moip2 ipo Command URL Allows set or get of MOIP Stream ID output parameters Command Information GET POST HTTP Methods Read Write Access Type User Admin Access Level 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 Multi...

Page 210: ...th a program entry ID value For POST any of the below URI arguments can be supplied with their associated value the user would like to set Note Table 166 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Program Entry Identifier Type Integer Values 1 40 for D9800 MS with 8 Transcoders 1 48 for MS with 16 Transcoders 1 16 for D9800 SS ipoid Bit...

Page 211: ...ource Type String Values User String SDT Channel ann_src Announce User s Title Type String Values Up to 32 characters ann_title FEC Mode Type String Values None 1D 2D fec_mode Fec Columns Depth Type Integer Values 1 20 fec_col Fec Rows Depth Type Integer Values 4 20 fec_row FEC Columns UDP Port Type Integer Values 1 65534 fec_colport Cisco D9800 Network Transport Receiver Version 2 75 RESTful Web ...

Page 212: ...e MOIP output bitrate to 12 5 and Time To Live TTL to 54 for MOIP stream which belongs to PE4 in SPTS mode The moip ipo ipoid VAL must be provided before adding the specific arguments as seen in the curl command below due to having to place level 1 parameter followed by level 2 followed by ipoid followed by optional arguments Note curl X GET i H Accept application json H X SESSION ID token k https...

Page 213: ... toc 0 ttl 64 src_port 0 ann_type None 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 Example 4 Get specific parameters of the MOIP Output Settings for a specific Stream PE 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 ...

Page 214: ...using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A For GET the URI arguments below will not contain values except for the decoder argument which if used must contain the value for the specific decoder users would like to retrieve information about For POST the arguments below will need to be specified with a val...

Page 215: ...t is assumed that the IP of the unit is 192 168 0 1 You must change the 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 ctrl If successful the return body will look like please note this is a snippet of the full return body decode ctrl decoder Video enable Yes decoder Audio1 enable Yes Example 3 Retrieve a s...

Page 216: ...d line arguments is limited to maximum of 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 For GET the URI arguments below will not contain values For POST the arguments below will need to be specified with a value In depth CURL examples can be seen below Note Trisync is not supported...

Page 217: ...s 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 change the 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 video If successful the following is an example of the return bod...

Page 218: ...yntax POST https 192 168 0 1 ws v2 service_cfg decode ar sdar value arselect value POST Syntax Setting Parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A For GET the URI arguments below will not contain values For POST the arguments below will need to be specified with a value In depth CURL examples c...

Page 219: ...wing 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 change the 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 ar If successful the return body will look lik...

Page 220: ...T https 192 168 0 1 ws v2 service_cfg decode ar opmode value POST Syntax Setting Parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A For GET the URI arguments below will not contain values For POST the arguments below will need to be specified with a value In depth CURL examples can be seen below Note ...

Page 221: ...lowing 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 change the IP to the specific unit IP in use This example sets the imitext Position to Standard and the Foreground Color to Auto curl X POST i H Accept application json H X SESSION ID token k ht...

Page 222: ...the unit is 192 168 0 1 You must change the IP to the specific unit IP in use The following example retrieves the imitext Position and the Foreground Color curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg decode subt imitext foregndcol If successful the return body will look like decode subt foregndcol Auto imitext Standard Closed Caption CC Decode ...

Page 223: ...e variable token In addition it is assumed that the IP of the unit is 192 168 0 1 You must change the IP to the specific unit IP in use This example sets the prefccmode to Auto curl X POST i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg decode cc prefccmode Auto If successful the return body will look like response code 10 result success message GET Examples ...

Page 224: ...tps 192 168 0 1 ws v2 service_cfg decode audio GET https 192 168 0 1 ws v2 service_cfg decode audio device device mode ac3comp left right pmtsrc ddpmode langmenu lang or GET https 192 168 0 1 ws v2 service_cfg decode audio device all This option is available in Version 2 75 or later Note This command format is currently equivalent to specifying the GET operation for service_cfg device audio withou...

Page 225: ...y to both GET and POST and are the same names used in the GET output fields For GET the URI arguments do not need any values except the device which must be specified For POST the device must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following the table Note Table 178 URI Query Set Arguments ...

Page 226: ...nd set it to the variable token In addition it is assumed that the IP of the unit is 192 168 0 1 You must change the IP to the specific unit IP in use This example sets the ddpmode to Pass The device index must be specified in the URI For this example the ddpmode will be set for audio device 1 Note curl X POST i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg d...

Page 227: ...es 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 change the IP to the specific unit IP in use This example sets the langmenu option to PMT 20Order The device all must be specified in the URI for PMT 20Order case because that setting value cannot be combined with ...

Page 228: ...successful curl 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 1 langmenu PMT 20Order The return body will look like response code 10 result failure message Select by PMT Order and Language cannot be combined Try changing settings for all Audio devices simultaneously To fix this issue use device all in the command to set the same v...

Page 229: ...To then achieve the device setting please proceed to next example Example 7 Attempt to set Audio decoder langmenu option to Language List or Language Entry on single device in combination with other devices that are already set to use Language Entry or Language List The following example assumes that the user has successfully logged onto the unit received the session ID and set it to the variable ...

Page 230: ...Syntax Setting Parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A 1 All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values except the device and sdiindex which must be specified For POST the device and sdiindex must be specified followed by any of th...

Page 231: ...index 1 curl 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 1 sdiindex 1 sdipref Compressed If successful the return body will look like response code 10 result success message GET Examples Example 2 Retrieve the Audio Device SDI Preference setting The following example assumes that the user has successfully logged onto the unit re...

Page 232: ...guments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values For POST at least one of the arguments must be specified along with the associated value the user would like to set In depth CURL examples can be seen below following the table...

Page 233: ...essful the return body will look like decode audio sdi1output PVO Audio ST302 Device Settings Command Table 183 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg decode aud_302 Command URL Allows set or get of audio ST302 decoder settings Command Information GET POST HTTP Method s Read Write Access Type User Admin Access Level GET https 192 168 0 1 ws v2 service_cfg de...

Page 234: ...Example 1 Set Audio ST302 Device Stream ID curl X POST i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg decode aud_st302 streamid 2 If successful the return body will look like response code 10 result success message GET Example Example 2 Retrieve the Audio ST302 Device Stream ID curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 w...

Page 235: ...l 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...

Page 236: ...ents do not need any values except the key arguments and values which must be specified For POST the key arguments and values must be specified followed by any of the other URI arguments and the associated value the user would like to set The GET result output field names re use the argument names and possible values This note applies to all of Audio URI Arguments VANC URI Arguments and VII URI Ar...

Page 237: ...NC Service Identifier Type String Value EIA 708 AFD DPI SMPTE 2031 SDP OP47 MULTI OP47 serviceid key Audio SDI Device Instance Type Integer Value 1 2 sdiindex key Enable or Disable VANC Service Type String Value Yes No or exist for GET output filtering enable Maximum Line Offset Allowed Type Integer Value 2 18 or exist for GET output filtering maxoffset Table 188 SDIVII URI Query Set Arguments pos...

Page 238: ...I parameters Command Information GET POST HTTP Methods Read Write Access Type User Admin Access Level All HDMI Video Settings for specified HDMI instance GET https 192 168 0 1 ws v2 service_cfg decode hdmi hdmiindex 1 Single HDMI Video Setting for specified HDMI instance GET https 192 168 0 1 ws v2 service_cfg decode hdmi hdmiindex 1 colorspace GET Syntax Single HDMI Video setting POST https 192 1...

Page 239: ...tance Type Integer Value 1 2 hdmiindex key HDMI Color Space Type String Value Auto YCbCr420 YCbCr444 YCbCr422 RGB colorspace HDMI Color Depth Type String Value Auto 16bit 12bit 10bit 8bit colordepth HDMI Color Range Type String Value Auto Full Limited colorrange HDMI Matrix Coefficients Type String Value Auto ITU 2020 CL ITU 2020 NCL ITU 470 XvYCC 709 XvYCC 601 ITU 709 SMPTE 170M matrixcoeff HDMI ...

Page 240: ...ontrol GET https 192 168 0 1 ws v2 service_cfg decode advaudio_control HDMI Advanced Audio Settings All HDMI Audio Settings GET https 192 168 0 1 ws v2 service_cfg decode advaudio_hdmi 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 ...

Page 241: ...ments do not need any values except hdmiindex which must be specified For POST all keys must be specified followed by any of the below non key URI arguments and the associated value the user would like to set The GET result output field names re use the argument names and possible values Note Table 192 Advanced Audio Control URI Query Set Arguments possible fields and values preceded by and separa...

Page 242: ...use the argument names and possible values Note Table 194 SDI Settings URI Query Set Arguments possible fields and values preceded by and separated by Description SDI Settings URI Argument Audio SDI Device Instance Type Integer Value 1 2 sdiindex key Audio Group Type Integer Value 1 4 group key Group Slot Type String Value 1 2 or 3 4 slot key Audio Input Type String Value PCM Pair 1 PCM Pair 2 PCM...

Page 243: ... 1 Single VBI Setting GET https 192 168 0 1 ws v2 service_cfg decode vbi vitspal17 GET Syntax POST https 192 168 0 1 ws v2 service_cfg decode vbi wstlnstart Standard vitspal17 Disable POST Syntax Setting parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Command URL separated by N A Table 196 URI Query Set Arguments possible fiel...

Page 244: ...BI Setting Arguments 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 change the IP to the specific unit IP in use The following example enables the VITC Color Mode and the VITC Drop Frame curl X POST i H Accept application json H X SES...

Page 245: ...on 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 change the IP to the specific unit IP in use The following example will retrieve the VITC Color Mode and the VITC Drop Frame curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg decode vbi vitcdropfr If successful the following is an example ...

Page 246: ...ey Applies to multi stream units only Multi Input Stream ID If not specified default value of 1 is used Type Integer Values 1 6 RF 1 ASI 1 32 MOIP stream Key optional Applies to multi stream units only PowerVu Conditional Access Mode Type String Value Std Open camode POST Examples Example 1 Set various PowerVu CA Setting Arguments The following example assumes that the user has successfully logged...

Page 247: ...ample of the return body ca pvu camode Std Running with the specific camode argument will return the same response as above as PowerVu CA only has one argument Note BISS CA Configuration Command Table 199 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg ca biss Command URL Allows set or get of BISS Conditional Access configuration Command Information GET POST HTTP Met...

Page 248: ...ype Integer Values 1 16 NFE 1 2 ASI 2 MOIP port Key Applies to multi stream units only Multi Input Stream ID If not specified default value of 1 is used Type Integer Values 1 6 RF 2 ASI 1 32 MOIP stream Key optional Applies to multi stream units only BISS Mode of operation Type String Value Mode 1 Mode E bissmode Mode 1 Session Word Type String Value String with 12 characters mod1seswrd Write Only...

Page 249: ...the unit is 192 168 0 1 You must change the 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 ca biss If successful the following is an example of the return body ca biss bissmode Mode 1 mod1seswrd modeseswrd modeinjid The mod1seswrd modeseswrd and modeinjid are write only so their values will not be shown when tryin...

Page 250: ...ions Note Table 202 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Send Query to CAM before enabling descrambling Type String Value Enable Disable sendquery Auto Reset CAM on failure Type String Value Enable Disable autoreset CA PMT List management mechanism Type String Value AddDel UpdateAll listmgmt Transport ID Original Network ID check ...

Page 251: ...lly 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 change the 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 ca ci If successful the following is an example of the return body ca ci sendquery Disable autoreset ...

Page 252: ...en this command is used as a GET command these arguments generally serve as output field descriptions Note Table 204 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Program Entry ID Type Integer Value 1 32 peid Program CAM Decrypt Mode Type String Value OFF ON Comp cidecrypt CAM Slot for Program Entry 1 Type String Value TOP BOTTOM AUTO cipe...

Page 253: ...n it is assumed that the IP of the unit is 192 168 0 1 You must change the 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 ca pe If successful the following is an example of the return body ca pe peid 1 cidecrypt ON cislot TOP cipe1slot TOP peid 16 cidecrypt ON cislot TOP cipe1slot AUTO CICOMP CA Configuration Comm...

Page 254: ...be used with POST When this command is used as a GET command these arguments generally serve as output field descriptions Note Table 206 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Index of Row in UIC Table Type Integer Value 1 64 idx Key Mandatory for POST command Program Entry ID Type Integer Value 1 32 peid CI Component Mode Type Stri...

Page 255: ...168 0 1 You must change the 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 ca cicomp If successful the following is an example of the return body ca cicomp idx 1 peid 1 mode PID pid 8192 strmcat USER strmval 0 strminst 1 oper Inactive idx 64 peid 1 mode PID pid 8192 strmcat USER strmval 0 strminst 1 oper Inactive ...

Page 256: ...esponse code 10 result success message Example 3 Retrieve the CICOMP Settings for a specific UIC Table row idx 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 change the IP to the specific unit IP in use Here is an example for row idx ...

Page 257: ...mmand URL separated by N A All of the URI Arguments in the table below apply to both GET and POST For GET the URI arguments do not need any values except the index which must be specified For POST the index must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following the table Note Table 208 URI ...

Page 258: ...he 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 change the IP to the specific unit IP in use The following example changes the bitratemode of transcoder 5 to CBR curl X POST i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg transcode ...

Page 259: ... service_cfg transcode hd index 5 If successful the following is an example of the return body transcode hd index 5 vres HD Output hres Full bitratemode CBR bitrate 16 0 gop User GOP MN usergop 15 2 pulldown32 Disabled Example 4 GET a specific HD transcode value for a specific transcoder The following example assumes that the user has successfully logged onto the unit received the session id and s...

Page 260: ...nd pulldown32 values from transcoder 5 Note In GET URIs only the index argument must contain a value for the transcoder all other arguments do not contain values Note 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 bitratemode bitrate pulldown32 If successful the following is an example of the return body transcode hd index 5 b...

Page 261: ... by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen in the following table Note Table 210 URI Query Set Arguments possible fields and values preceded by and separated by Description URI Argument Transcoder to be configured Type Integer Values 1 N number of transcoders depends on model and installed options index Key Select the v...

Page 262: ...Type String Values 4 3 16 9 aspectratio Select the desired aspect ratio conversion method for SD video output Type String Values None Auto Auto AFD 16 9 L B 4 3 P B 14 9 4 3 CCO 16 9 SCALE aspectconv Select which content to place in the first Closed Captioning Packet for SD video output Type String Values None CEA 708 SCTE 20 ccpkt1 Select which content to place in the second Closed Captioning Pac...

Page 263: ... Disabled If successful the following is an example of the return body response code 10 result success message GET Examples Example 3 GET the full SD transcoder values for a specific transcoder 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 Yo...

Page 264: ...ssion 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 change the IP to the specific unit IP in use The following example retrieves multiple parameter values from the HD transcoder settings for transcoder 5 The user must specify the index number in the URI followed by the URI arguments the user wishes to retrieve The following example re...

Page 265: ...r the URI Parameters extension to the Command URL separated by N A All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values except the index which must be specified For POST the index must be specified followed by any of the below URI arguments and the associated value the user would like to set In depth CURL examples can be seen below following th...

Page 266: ...ol POST Examples Example 1 Changing one SUBT Transcoding Parameter 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 change the IP to the specific unit IP in use This example changes the opmode of transcoder 5 to Imitext curl X POST i H ...

Page 267: ...specific unit IP in use The following example retrieves all of the SUBT transcoder settings for transcoder 5 The user must specify the index in the URI Note curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg transcode subt index 5 If successful the following is an example of the return body transcode subt index 5 opmode Imitext langmenu PMT Order pmto...

Page 268: ...transcoder settings for transcoder 5 The user must always specify the port number in the URI followed by the URI arguments the user wishes to retrieve This example retrieves the langmenu langentry and foregndcol values from transcoder 5 Note In GET URIs only the index argument must contain a value for the transcoder all other arguments do not contain values Note curl X GET i H Accept application j...

Page 269: ...here is a loss of input Type String Value Black Output No Output lossofinput POST Examples Example 1 Changing one user parameter 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 change the IP to the specific unit IP in use The following...

Page 270: ...cific unit IP in use The following example retrieves one specific parameter value from the user settings curl X GET i H Accept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg user lossofinput If successful the following is an example of the return body user lossofinput No Output Disaster Recovery D R Configuration API This section describes the disaster recovery command...

Page 271: ...to wait before declaring signal is lost Type Integer Value 5 2160000 siglost Amount of time allowed for verification to complete Type Integer Value 10 255 verify POST Examples Example 1 Set various D R global Setting Arguments 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...

Page 272: ...urrently supported Note Disaster Recovery D R Backup Transport Configuration Command Table 217 Command Details Description Command Detail https 192 168 0 1 ws v2 service_cfg dr tuning Command URL Allows set or get of D R backup transport configuration Command Information GET POST HTTP Methods Read Write Access Type User Admin Access Level All D R backup tuning Settings GET https 192 168 0 1 ws v2 ...

Page 273: ... by Description URI Argument Record index of D R backup tuning configuration Type Integer Values 1 3 csirec Key D R backup tuning status Type String Values Active Inactive rowstatus D R backup tuning RF input selection Type String Values RF1 RF2 RF3 RF4 input D R backup tuning network id Type Integer Values 0 65535 netid D R backup tuning Frequency GHz Type Float Values 0 0 15 0 dnlkfreq D R backu...

Page 274: ...te 30 If successful the return body will be response code 10 result success message GET Examples Example 2 Retrieve the full D R backup Settings 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 change the IP to the specific unit IP in u...

Page 275: ...68 0 1 ws v2 service_cfg dr channels Single D R backup channels Setting GET https 192 168 0 1 ws v2 service_cfg dr channels peid PE1 csirec 1 bkpchan GET Syntax POST for example https 192 168 0 1 ws v2 service_cfg dr channels peid PE1 csirec 1 bkpchan 201 POST Syntax Setting Parameters using command line arguments is limited to maximum of 26 arguments after the URI Parameters extension to the Comm...

Page 276: ...ept application json H X SESSION ID token k https 192 168 0 1 ws v2 service_cfg dr channels peid PE1 csirec 1 bkpchan 30 If successful the return body will look be response code 10 result success message GET Examples Example 2 Retrieve the full D R backup Settings The following example assumes that the user has successfully logged onto the unit received the session ID and set it to the variable to...

Page 277: ... Methods Read Write Access Type User Admin Access Level All port Info GET https 192 168 0 1 ws v2 device_ctl eth Single Ethernet port info GET https 192 168 0 1 ws v2 device_ctl eth port portid 1 Single Ethernet port item GET https 192 168 0 1 ws v2 device_ctl eth port portid 1 ipv4addr GET Syntax This command uses the ports referenced in Port Information on page 8 However in this API all of the p...

Page 278: ...e specified When the command URL is https 192 168 0 1 ws v2 device_ctl eth port then the command line must also specify the portid URI Query Set argument and value port All of the URI Arguments below apply to both GET and POST For GET the URI arguments do not need any values except the index which must be specified For POST the index must be specified followed by any of the below URI arguments and...

Page 279: ...c port or port field information according to the input parameters Show all port Info in XML format curl k H X SESSION ID token https 192 168 0 1 ws v2 device_ctl eth 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 ...

Page 280: ...t values are for example purposes only devicectl eth port portid 2 ipv4addr 192 168 1 2 POST Method Examples Configure physical Ethernet Port When the Management Port IP is changed the connection will be immediately lost and user have to re login the system this will also result in the token not being returned In order to avoid mixing the command with other commands together IP control port config...

Page 281: ...el All version Info GET https 192 168 0 1 ws v2 device_ctl ver GET Syntax Select a version POST https 192 168 0 1 ws v2 ver verselect idx s w version idx reboot Yes Delete a version POST https 192 168 0 1 ws v2 ver verselect idx s w version idx erase Yes POST Syntax Only HTTP data body is supported POST from XML JSON file is not supported Table 225 Level_1 URI Parameters extension to the Command U...

Page 282: ...o reboot To delete the software version to be selected Type String Value Yes No erase Format output using JSON standard Type exist 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 js GET Method Examples Display runnable software versions information in XML or JSON Show all version info in XML curl k H X SESSION ...

Page 283: ...w all version Info in JSON devicectl ver verselect idx 0 name 1 10 reboot No erase No idx 1 name T2 25C1 reboot No erase No idx 2 name T2 25B7 reboot No erase No idx 3 name reboot No erase No idx 4 name reboot No erase No idx 5 name reboot No erase No idx 6 name reboot No erase No idx 7 name reboot No erase No idx 8 name reboot No erase No POST Method Examples Select a software version to run or d...

Page 284: ...Command Details Description Command Detail https 192 168 0 1 ws v2 device_ctl reset Level_1_URI_Parameter Command URL Allows performing a device reset or factory reset restore factory default settings A device reset reboots the target unit A factory reset does not trigger any reboot for D9800 Command Information POST HTTP Method Write Access Type User Admin Access Level N A GET Syntax Factory Rese...

Page 285: ...mples Factory Reset or Reboot the unit Factory reset curl k X POST H X SESSION ID token https 192 168 0 1 ws v2 device_ctl reset factory js 1 If successful the following is an example of the return body response code 10 result success message Reboot curl k X POST H X SESSION ID token https 192 168 0 1 ws v2 device_ctl reset reboot js 1 If successful the following is an example of the return body r...

Page 286: ...cols http GET Syntax Change SNMP protocol configuration POST https 192 168 0 1 ws v2 device_ctl protocols snmp Enable Change IGMP protocol configuration POST https 192 168 0 1 ws v2 device_ctl protocols igmp Disable POST Syntax Only HTTP data body is supported POST from XML JSON file is not supported Table 231 URI Query Set Arguments possible fields and values preceded by and separated by Descript...

Page 287: ... or js 0 or js 9999 are valid Omitting this argument formats the output by default in XML js GET Method Examples Display protocol control information in XML or JSON 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...

Page 288: ...ols settings http HTTPS POST Method Examples Change protocol control configurations 1 Change SNMP protocol configuration curl k X POST H X SESSION ID token https 192 168 0 1 ws v2 device_ctl protocols snmp Enable js 1 If successful the return body will be response code 10 result success message Success And SNMP protocol will be enabled 2 Change IGMP protocol configuration curl k X POST H X SESSION...

Page 289: ...d 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 2 Wait on status Diagnostics Operation Status API 3 Retrieve the output data of the command via GET API response 4 Format the raw data retrieved from th...

Page 290: ...3 4 Data Port 4 For single stream unit 0 Management port 1 Data Port 1 2 Data Port 2 port mandatory Specify the target IPv4 address Type String ip dot format ip mandatory Example issue the IP diagnostics trigger command Input append js for output in JSON format curl k H X SESSION ID token X POST https 192 168 0 1 ws v1 ip_diags trigger command ping port 0 ip 192 168 0 72 Expected output for Succes...

Page 291: ...e reason details may be available by calling the DIAGSTAT API Note In XML HTTP 1 1 200 OK Date Mon 26 Jun 2017 11 29 29 GMT Server Hiawatha v9 14 Connection keep alive Transfer Encoding chunked Status 200 Content type application xml xml version 1 0 encoding ISO 8859 1 response code 10 code result failure result message failure to trigger request message response In JSON HTTP 1 1 200 OK Date Mon 2...

Page 292: ...n operation as a percent HELP_STR_1 HELP_STR_2 CDATA Item attribute min 0 max 100 step size 1 unit HELP_STR_2 ITEM RECORD TABLE HDR Expected output example when diagnostics package preparation is 100 completed successfully xml version 1 0 encoding ISO 8859 1 HDR TABLE RECORD ITEM ID 0x002D2600 ID VALUE CDATA Pass VALUE NAME CDATA OPERSTATUS NAME HELP_STR_1 CDATA Indicates whether the most recent o...

Page 293: ...to allow the internal states to clear If at any time the OPERSTATUS is Fail then the client software will abort additional checking and report the last DETAILEDSTATUS IP Diagnostics Report Retrieval Command Table 235 Command Details Description Command Detail https 192 168 0 1 ws v2 ip_diags Command URL Retrieves the last IP diagnostics report after last 100 completed operation status Command Info...

Page 294: ...s from 10 132 24 34 seq 0 ttl 61 time 0 819 ms n64 bytes from 10 132 24 34 seq 1 ttl 61 time 1 498 ms n64 bytes from 10 132 24 34 seq 2 ttl 61 time 0 740 ms n64 bytes from 10 132 24 34 seq 3 ttl 61 time 0 687 ms n64 bytes from 10 132 24 34 seq 4 ttl 61 time 0 677 ms n n 10 132 24 34 ping statistics n5 packets transmitted 5 packets rece message2 ved 0 percent packet loss nround trip min avg max 0 6...

Reviews:

No comments

Related manuals for D9800

MDS Mercury Series

Brand: GE Pages: 4

Brand: Ramsey Electronics Pages: 28

VOS-8FOM-D232MR

Brand: Voscom Pages: 17

Brand: Zamel Pages: 21

Brand: VDO Pages: 18

Brand: CAME Pages: 8

Brand: iSimple Pages: 12

Brand: Onkyo Pages: 111

Brand: Crestron Pages: 40

Brand: TECshow Pages: 18

SRT 4356 PVR Evolution

Brand: Strong Pages: 74

Brand: Miraclebox Pages: 124

HD-RX-4K-x10-C-E

Brand: Crestron Pages: 56

SAN FRANCISCO RDM 127

Brand: Blaupunkt Pages: 32

Brand: Onkyo Pages: 159

BVA 8051 series

Brand: Leadtek Pages: 11

Brand: CYP Pages: 32

Brand: Audioplex Pages: 2

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands