Cisco D9800 Network Transport Receiver Version 2.

75 RESTful Web
Services API Reference Guide
First Published: 2017-10-23

Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,
INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH
THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,
CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The following information is for FCC compliance of Class A devices: This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15
of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment
generates, uses, and can radiate radio-frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications.
Operation of this equipment in a residential area is likely to cause harmful interference, in which case users will be required to correct the interference at their own expense.

The following information is for FCC compliance of Class B devices: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15
of the FCC rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio
frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference
will not occur in a particular installation. If the equipment causes interference to radio or television reception, which can be determined by turning the equipment off and on, users are
encouraged to try to correct the interference by using one or more of the following measures:

• Reorient or relocate the receiving antenna.

• Increase the separation between the equipment and receiver.
• Connect the equipment into an outlet on a circuit different from that to which the receiver is connected.
• Consult the dealer or an experienced radio/TV technician for help.
Modifications to this product not authorized by Cisco could void the FCC approval and negate your authority to operate the product

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public domain version
of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED "AS IS" WITH ALL FAULTS.
CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT
LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS
HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network
topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional
and coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://
www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1110R)

With each AVC/H.264 product, we are obligated to provide the following notice:

AVC VIDEO LICENSE

THIS PRODUCT IS LICENSED UNDER THE AVC PATENT PORTFOLIO LICENSE FOR THE PERSONAL AND NON-COMMERCIAL USE OF A CONSUMER TO (i) ENCODE
VIDEO IN COMPLIANCE WITH THE AVC STANDARD ("AVC VIDEO") AND/OR (ii) DECODE AVC VIDEO THAT WAS ENCODED BY A CONSUMER ENGAGED IN A
PERSONAL AND NON-COMMERCIAL ACTIVITY AND/OR WAS OBTAINED FROM A VIDEO PROVIDER LICENSED TO PROVIDE AVC VIDEO. NO LICENSE IS GRANTED
OR SHALL BE IMPLIED FOR ANY OTHER USE. ADDITIONAL INFORMATION MAY BE OBTAINED FROM MPEG LA, L.L.C. SEE http://www.mpegla.com.

Accordingly, please be advised that service providers, content providers, and broadcasters are required to obtain a separate use license from MPEG LA prior to any use of AVC/H.264
encoders and/or decoders.

© 2017 Cisco Systems, Inc. All rights reserved.

 CONTENTS

Preface Preface ix
Audience ix
Conventions ix
Related Documentation x
Obtaining Documentation and Submitting a Service Request xi

CHAPTER 1 Web Services API 1

About Web Services API 1
Accessing Web Services API 1
Access Level (Login and Logout) 2
HTTP Request Methods 3
Get 3
Post 4
HTTP Responses 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

CHAPTER 2 API Definitions 11

Legacy API 11
Backup Command 11
Restore Command 13

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
iii
 Contents

Download User Defaults (Customer Presets) Command 14

BKPRST Status Command 14
Legacy CDT Upload Command 15
Chunky CDT Upload Command 16
Determining Support for Chunky CDT Upload Command 19
Upload Software License File Command 21
Diagnostics Package (Export Debug File) Commands 22
Diagnostics Package Trigger Command 22
Diagnostics Package Operation Status Command 23
Diagnostics Package Retrieval Command 24
Status API 25
RF Input Status Command 25
ASI Input Status Command 31
IP Input Status Command 35
ABR Input Status 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 STC302 Decode Status Command 85
Closed Caption (CC) Decode Status Command 86
VBI Decode Status Command 88
SDI Decode Status Command 89
HDMI Decode Status Command 93
Identity Status Command 96
Device Status Command 102

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
iv
Contents

About Status Command 103

ECC Status Command 107
Ethernet Status Command 112
Power Status Command 114
Alarms and Warnings 116
Fault Details Status Command 116
Fault Actions Status Command 118
Faults Summary Status Command 119
Faults Status Command 121
Faults History Status Command 123
Disaster Recovery (D/R) Status Command 125
Disaster Recover (D/R) Global Status Command 127
Disaster Recover (D/R) Backup Tuning Status Command 128
Disaster Recover (D/R) Backup Channels Status Command 131
Disaster Recovery (D/R) Origin Tuning Status Command 132
Disaster Recover (D/R) Origin Channels Status Command 134
Configuration API 135
Input 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 Configuration Command 184
MOIP Global Output Configuration Command 188
DPM ASI/MOIP PE Output Configuration Command 193
MOIP Output Stream Configuration 197
Decode Configuration Commands 202
Control Decode Configuration Command 202
Video Decode Configuration Command 204
Aspect Ratio (AR) Decode Configuration Command 206

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
v
 Contents

Subtitle (SUBT) Decode Configuration Command 208

Closed Caption (CC) Decode Configuration Command 210
Audio Decode Configuration Command 212
Audio Device SDI Preference Setting Command 218
Audio Device SDI1 or SDI2 Output Settings Command 220
Audio ST302 Device Settings Command 221
SDI Decode Configuration Command 223
HDMI Decode Configuration Command 226
Advanced Audio Decode Configuration Command 228
VBI Configuration Command 231
CA (Conditonal Access) Configuration Commands 233
PowerVu (PVU) CA Configuration Command 233
BISS CA Configuration Command 235
CI (Common Interface) Configuration Command 237
PE CA Configuration Command 239
CICOMP CA Configuration Command 241
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 Channels Configuration Command 263
Device Control Commands 265
Ethernet Device Control Command 265
Version Selection Device Control Command 269
Reset Device Control Command 272
Protocol Device Control 274
Download Device Control Settings 277
Diagnostics API 277
IP Diagnostics Commands 277
IP Diagnostics Trigger Command 277
IP Diagnostics Operation Status Command 280

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
vi
Contents

IP Diagnostics Report Retrieval Command 281

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
vii
 Contents

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
viii
 Preface
This section describes the audience and conventions of the Cisco D9800 Network Transport Receiver API
Reference Guide. It also references related documentation and describes how to obtain documentation and
submit a service request.

• Audience, page ix
• Conventions, page ix
• Related Documentation, page x
• Obtaining Documentation and Submitting a Service Request, page xi

Audience
The audience of this guide includes developers who will build a client application to interface with the D9800
Network Transport Receiver.

Conventions
This guide uses the following conventions.
Conventions Indication
bold font Commands and keywords and user-entered text appear in bold font.

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

[] Elements in square brackets are optional.

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

vertical bars.

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

vertical bars.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
ix
 Preface
Related Documentation

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

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

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

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

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

code indicates a comment line.

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

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

Warning IMPORTANT SAFETY INSTRUCTIONS

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

Related Documentation
• Cisco D9800 Network Transport Receiver Installation and Configuration Guide, available at the following
URL: http://www.cisco.com/go/receivers_guides.
• Release Notes for Cisco D9800 Network Transport Receiver, available at the following URL: http://
www.cisco.com/go/receivers_release_notes.
• Open Source Used In Cisco D9800 Network Transport Receiver, available at the following URL: http:/
/www.cisco.com/go/receivers_licensing.
• Cisco D9800 Network Transport Receiver Data Sheet, available at the following URL: http://
www.cisco.com/c/en/us/products/video/digital-receivers-decoders/datasheet-listing.html.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
x
 Preface
Obtaining Documentation and Submitting a Service Request

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service
request, and gathering additional information, see What's New in Cisco Product Documentation.
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's
New in Cisco Product Documentation RSS feed. 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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
xii
 CHAPTER 1
Web Services API
This section describes the web services API used to control the D9800 Network Transport Receiver, including
HTTP request and response methods, URI arguments, and port information.

• About Web Services API, page 1

• Accessing Web Services API, page 1
• Access Level (Login and Logout), page 2
• HTTP Request Methods, page 3
• HTTP Responses, page 4
• XML or JSON Response Body, page 6
• Base URI, page 7

About Web Services API

Web services API is a standard interface designed for the D9800 Network Transport Receiver. It replaces the
previous interfaces, such as TELNET. The web services API is designed to be flexible and address different
functionality requirements of an interface, such as concurrent 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 unit. By
default, the D9800 web server redirects all incoming web traffic to HTTPS on port 443 and will respond to
all HTTP URI requests with a redirect response to the equivalent HTTPS URI.
The APIs in this document that has the /ws/v1/ extension indicates a version 1 (Legacy) web services API,
and the /ws/v2/ extension indicates a version 2 web services API. For example,
https://192.168.0.1/ws/v2/show/inventory.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
1
 Web Services API
Access Level (Login and Logout)

To access a single API, you can use cURL. For more information, see https://curl.haxx.se/. Since SSL
certificates on D9800 units are self-signed, you can use "-k DEFAULT" options to bypass the security checks
of the cURL command.
Example 1:
curl -k -i -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/test/show/id-eeprom"

Example 2:
curl -k "https://192.168.0.1/ws/v2/test/show/id-eeprom&session=$token"

Note The DEFAULT –k cipher option might not be available in older versions of the cURL command. An
updated version of the tool is required to enable this option. Follow your operating systems instructions
to update your cURL. For example, on CEL/Fedora, issue the following command as a root user and then
restart:
yum update curl

The –H "X-SESSION-ID: $token" (or session=$token) part of the cURL syntax is required for each command
in order to propagate the HTTP session_id. The $token represents a Linux (or Cygwin if that is the Host
environment) environment variable that is based on the value of the XML <SESSION></SESSION> item
from the successful Login response.
For an example of the login command, and setting the $token environment variable, see Access Level (Login
and Logout), 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 command.

Input:
curl -k https://192.168.0.1/ws/v1/table?t=return -X POST -d
"<HDR><LOGIN><UID>admin</UID><USERPASS>localadmin</USERPASS></LOGIN></HDR>" -H "Content-Type:
text/xml; charset=UTF-8"
Expected output:
?xml version="1.0" encoding="ISO-8859-1"?>
<HDR><TABLE><ITEM><ID>STATUS</ID><VALUE>Please wait while the default page loads up
....</VALUE></ITEM><LOGIN_INFO><USER_NAME>admin</USER_NAME><USER_ROLE>ADMIN</USER_ROLE><SESSION_ID>TokenValue</SESSION_ID></LOGIN_INFO></TABLE></HDR>
Where Session TokenValue should be used in each subsequent Web Server API commands.
In each of the commands described in this document, the –H "X-SESSION-ID: $token" (or appended
"session=$token") portion of the curl request syntax passes the value of $token environment variable.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
2
 Web Services API
HTTP Request Methods

The value of the $token variable needs to be set based on the TokenValue from the XML response to the
Login Command. This may be done by using the Linux (or Cyqwin) export command.
The example below assumes TokenValue = 869a010f-16e9-4b5a-b302-0097c779850f.
…<SESSION_ID>869a010f-16e9-4b5a-b302-0097c779850f </SESSION_ID>…
Usage Example (setting $token environment variable):
export token=869a010f-16e9-4b5a-b302-0097c779850f
An alternative to setting the environment variable is to replace $token with the literal string from the above
(XML) output when calling the additional command(s). The following is an example of a logout command.
Input:
curl -k https://192.168.0.1/ws/v1/table?t=return -X POST -d "<HDR><LOGOUT><ITEM><REASON>User
Logout</REASON></ITEM></LOGOUT></HDR>" -H "Content-Type: text/xml; charset=UTF-8" -H
"X-SESSION-ID: $token"
Expected output:
?xml version="1.0" encoding="ISO-8859-1"?>
<HDR><TABLE><ITEM><ID>STATUS</ID><VALUE>Please wait while the default page loads up
....</VALUE></ITEM><LOGIN_INFO><USER_NAME></USER_NAME><USER_ROLE>NotValid</USER_ROLE><SESSION_ID>NONE</SESSION_ID></LOGIN_INFO></TABLE></HDR>

HTTP Request Methods

HTTP methods are defined by RFC 1945. We currently support GET and POST methods.

Get
GET is used for URI requests that have no payload to transfer in their bodies. GET can be formatted 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 -k "https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&js=1&session=$token"
The resource URI must be in quotes if you pass in multiple query parameters separated by ‘&’. If you have
spaces in the query values, you should encode them. For example, use the + symbol, or the %20 symbol,
instead of a space (http://blogs.plexibus.com/2009/01/15/rest-esting-with-curl/).
A maximum of 26 arguments (after the ? symbol, and not including the session and json arguments) can be
queried in a single GET operation from a Web Services API cURL command line request. If a GET request
is made that specifies more than this amount, the response behavior is undefined (typically, the extra request
parameters will be ignored). We strongly recommend that you use the alternate block read method to retrieve
many arguments at once.
The following is an example of a Block Data GET request.
Passing a block of XML data from a file:
curl -k -i -H "X-SESSION-ID: $token" --header "Content-type:application/xml" -d @"input.xml"
"https://192.168.0.1/ws/v2/service_cfg/input"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
3
 Web Services API
Post

Or
curl -k --header "Content-type:application/xml" -d @"input.xml"
"https://192.168.0.1/ws/v2/service_cfg/input?session=$token"

Post
POST is used when a request body (in XML, JSON, or other formats) is present and is transferred to the unit
with the request. The following lists three ways to use cURL to post parameters and arguments.
1 Using only arguments on command line separated by "&" (Maximum of 26 arguments, excluding JSON
argument and session argument):
curl -k -i -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=[port#]&dnlkfreq=<Freq>"
curl -k -i -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=2&dnlkfreq=12.31"
Or:
curl -k -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=[port#]&DnlkFreq=<Freq>&session=$token"
<?xml version="1.0" encoding="ISO-8859-1"
?><response><code>10</code><result>success</result><message></message></response>
The resource URI needs to be quoted if you pass in multiple query parameters separated by ‘&’. If you
have spaces in the query values, you should encode them. For example, use the + symbol or %20 instead
of a space.
2 Using xml 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-ID: $token" -X POST --header "Content-type:application/xml" -d
@"input.xml" https://192.168.0.1/ws/v2/service_cfg/input
Or
curl -k -i -X POST --header "Content-type:application/xml" -d @"input.xml"
"https://192.168.0.1/ws/v2/service_cfg/input?session=$token"

A maximum of 26 arguments (after the ?, and not including the session and json arguments) can be set in a
single POST operation from a Web Services API cURL command line request. If a POST request is made
that specifies more than the maximum, the response behavior is undefined (typically, the extra request
parameters are ignored). We highly recommend that you use the alternate write from file method to set multiple
arguments at the same time.

HTTP Responses
This section describes the HTTP status codes and content response types.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
4
 Web Services API
HTTP Status Codes

HTTP Status Codes

All HTTP commands respond with a status code that identifies if the client or server encountered any protocol
or URL mapping issues. For the command to proceed (for example, return valid data), the HTTP status code
must display the value 200 (HTTP_OK). Any other HTTP response code indicates an error and the data
content will not be received. That is, if the client expects an XML (or JSON) response, then it must first check
that the HTTP status code in the HTML header of the response is 200.
For client software or debugging purposes, you may want to dump the HTTP response header (which shows
the status code) via the curl -i parameter.
The following is an example of an invalid command for which HTTP 404 error is returned:
curl -i -k -H "X-SESSION-ID: $token" -X POST"https://192.168.0.1/ws/v2/invalid_command

HTTP/1.1 404 Not Found

Date: Fri, 23 Oct 2015 19:26:40 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 404
The following is a list of the common HTTP return codes when communicating with D9800 (refer to RFC-1945
for the full list and descriptions):
200_HTTP_OK

400_HTTP_BAD_REQUEST

401_HTTP_UNAUTHORIZED

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_SUPPORTED

Content Response Types

When HTTP status code is HTTP_OK (value 200), there are two types of content responses available:
1 application/xml
2 application/json

When not specified, the response content is returned in XML format.

When js=1 is specified as an appended "&" parameter, then the response is returned in JSON format.
When a legacy API (for example, backup, restore_upload, cdt_upload, diagnostics) is being called, the response
may be in command specific XML or HTML format only and does not support the Generic Response XML
format or Json (js=1) options. Refer to the commands for specific descriptions.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
5
 Web Services API
XML or JSON Response Body

XML or JSON Response Body

When a WS V2 or higher API is executed, and HTTP status code is HTTP_OK (value 200), a XML/JSON
response body is returned, to indicate the API result.
The following is an example of the GET method API, used to query the receiver data. If the GET API is
successfully executed, the response body displays the requested data.
$ curl -k -H "X_SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/input/rf?port=1&js=1"
{
"input": {
"rf": {
"port": "1",
"dnlkfreq": "28.3465",
"symrate": "28.3465",
"fec": "2/3",
"mod": "QPSK DVB-S",
"rolloff": ".35",
"iq": "Normal",
"pwr": "Off",
"sel22khz": "Off",
"lo1": "5.15",
"lo2": "0.0",
"pol": "Horizontal",
"orbpos": "0.0",
"ewflag": "N/A",
"afcrange": "3.0",
"acqmode": "Basic",
"satlock": "No Lock",
"inputrate": "0.0",
"netname": "",
"netid": "1",
"transid": "",
"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 admin or user)"
}
}
The following is an example of the POST method API. It displays a generic "success" response. An API
requires a specific response body when a POST API is executed successfully.
$ curl -k -H "X_SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&&dnlkfreq=3.51&js=1"
{
"response": {
"code": "10",
"result": "success",
"message": ""
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
6
 Web Services API
Base URI

If an error occurs, a generic "failed" response is given. For example:

$ curl -k -H "X_SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?js=1"
{
"response": {
"code": "10",
"result": "failed",
"message": "Missing Key"
}
}

Note The "code" in the generic "failed or success" response body is not used (most command responses set it
to 10). We highly recommend that you do not change the field, unless otherwise indicated in the command
descriptions.

Base URI
The base URI for an API indicates a specific or a group of functionalities, which is used in conjunction with
URI parameters and options.

URI Parameters
Each web service API can have one or more URI parameters that can alter the semantics of the API. URI
parameters are appended to the base URI. For instance, a request to Show 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 parameters
or base URI by a "?" character and are separated from each other by the "&" character.
Each option has a name and a value. For instance, in the URL
"https://192.168.0.1/ws/v2/test/show/id-eeprom?card=NDM", the string "card" indicates an option with its
value set to "NDM".
• Argument Description
A brief description of the argument item.
• Argument Type
Currently 5 different data types are supported for query options:
1 Integer
2 String
3 Boolean

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
7
 Web Services API
Access Type

4 IP Address
5 Float

• Argument Values
Values define a specific or a range of acceptable values for the option. The following list shows some
examples of how the values or the range of values are identified in this document:
1 Integer: [1 ... 40] identifies range of values from 1 to 40.
2 String: * is used as wildcard.
3 Boolean: 0 is false and 1 is true.
4 IP Address: e.g. 192.160.0.1
5 Float: 30.5

• Argument Applies To
Identifies which URI parameters a certain URI argument applies to. For example, the string "Applies:
id-eeprom, status-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 to the D9800 receiver.

Port Information
There are three types of NTC boards:

NTC Board Port Description

NTC Basic One Ethernet port:
• Management

NTC MOIP Three Ethernet ports:

• Management
• DATA1
• DATA2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
8
Web Services API
Port Information

NTC Board Port Description

NTC-MS Five Ethernet ports:
• Management
• DATA1 and DATA2 (first data port pairs)
• DATA3 and DATA4 (second data port pairs)

When using "port" as a URI argument for web services API commands, the ports are referred to as port 0,
port 1, port 2, and so on.
"Management port" is port 0. This can be used on all three types of NTC boards.
DATA1 is port 1. This can be used on NTC MOIP and NTC-MS boards.
DATA2 is port 2. This can be used 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.

Note When connecting to a unit to run web services API commands, the Management port (port 0) is used to
establish and maintain the connection.

The ports are labeled on the backplane of an assembled unit. The Management port (port 0) is labeled
Management. The DATA ports are labeled DATA1, DATA2, DATA3, and DATA4.

Note The Management port is also referred to as "Control port" in this document.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
9
 Web Services API
Port Information

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
10
 CHAPTER 2
API Definitions
This section describes the API definitions for controling the D9800 Network Transport Receiver.

• Legacy API, page 11

• Status API, page 25
• Configuration API, page 135
• Device Control Commands, page 265
• Diagnostics API, page 277

Legacy API
The legacy API commands use the ws/v1 (Web Services v1 API) or legacy command 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

Command Detail Description

Command URL https://192.168.0.1/ws/v1/backup?t=option

Command Information Backup specific types of database data from the

device to your local machine.

HTTP Method GET

Access Type Read

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
11
 API Definitions
Backup Command

Table 2: Options

Option Description
STD Backs up standard data.

UD Backs up user changes to factory data (customer

presets).

EXT Backs up all standard data and user data.

Example of issuing the backup command (assuming the STD option is specified):
Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/backup?t=STD"
Expected output (may not be exactly as shown):
<BKPRST>
<FILE_INFO><PLAT_TYPE>D9800</PLAT_TYPE><DESIGNATION>10</DESIGNATION>
<VERSION>1.00</VERSION>
<DATE_TIME>Date YYYY/DD/MM 2015/07/20 Time HR:MIN:SEC 20:57:33</DATE_TIME>
<FILE_NAME>file name</FILE_NAME></FILE_INFO>
<SETTINGS>
<BKPRST>
</SETTINGS>
<RECORD>
<OID>1.3.6.1.4.1.1482.20.1.9.1.1.2.1</OID>
<VALUE>6C410A0A</VALUE>
</RECORD>
…other XML records …
</SETTINGS>
…other XML data …
</BKPRST>

Note The XML response is not immediate and may take several seconds to complete. While the Backup command
is in progress, the BKPRSTSTAT UIC table should not be queried by other curl clients other than the UI
(if at all), in order to reduce the risk of timeout due to inter process call 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 preparation for any subsequent Backup
or Restore operation. The availability of the new Backup XML data (or file Save As dialog in the case of
using the UI Browser) is the valid indicator for the successful completion of this command. If there is an
issue with generating the Backup file, then the BKPRSTSTAT UIC table Operation Status will indicate
the Fail state, with the Detailed Status field, indicating the reason for the Failure. Check this data only
after the command returns. If there is a problem with file transfer, timeout, or invoking the command,
then the XML response to this command will indicate a failure response through the legacy command
Status form.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
12
 API Definitions
Restore Command

Restore Command
Table 3: Command Details

Command Detail Description

Command URL -F restorefile=@"file_path/file_name"
"https://192.168.0.1/restore_upload.html"

Command Information Restore database file(s) onto the device.

HTTP Method POST

Access Type Write

Access Level User, Admin

Options: N/A
Example of issuing the restore command (assuming the filename is D9800.bkp):
Input:
curl -k -i –H "X-SESSION-ID: $token" -X POST -F
restorefile=@"C:/projects/d9800/D9800.bkp" "https://192.168.0.1/restore_upload.html"
Expected output:
<html><body></body></html>

Note The XML response is almost immediate (a few seconds at most) and does not indicate that the restore
command operation is completed.
Prior to initial run of this command after startup (prior to any Backup or Diagnostics operation), the
BKPRSTSTAT table may indicate that the operationStatus="Pass" while detailedStatus="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 command
must consider that
ALL three items ("Pass" plus "Idle" plus "100") must coincide in order to consider Restore operation to
be Successfully completed.
The progress and results of the Restore command may be determined by calling the BKPRSTSTAT
command every few seconds until it reports that the file restore is completed at 100 percent, or that it was
aborted (operationStatus="Fail") due to errors.
This operation may take over one minute, depending on the amount of data to validate and restore.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
13
 API Definitions
Download User Defaults (Customer Presets) Command

Download User Defaults (Customer Presets) Command

Table 4: Command Details

Command Detail Description

Command URL -F restorefile=@"ud_file_path/ud_file_name"
"https://192.168.0.1/restore_upload.html"

Command Information Download customer presets (user defaults) onto the device. This
command is a variation of the Restore command. The XML format
of the ud_file_name determines whether to change the user defaults
data.
To make the user defaults data persistent, this command must be
followed by a Factory Reset command (see Reset Device Control
Command, on page 272).

HTTP Method POST

Access Type Write

Access Level Guest, User, Admin

Options: N/A
Example of issuing the restore user defaults command (assuming the filename 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 until it reports that the file restore is completed at 100 percent, or that it was aborted due
to any possible error.
This operation may take over one minute, depending on the amount of data to validate and restore.

BKPRST Status Command

Table 5: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v1/table?t=BKPRSTSTAT

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
14
 API Definitions
Legacy CDT Upload Command

Command Detail Description

Command Information Return information about Backup/Restore Status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Example of issuing the BKPRST status command:

Input:
curl -k -H "X-SESSION-ID: $token" https://192.168.0.1/ws/v1/table?t=BKPRSTSTAT
Expected output (example only, subject to change):
<?xml version="1.0" encoding="ISO-8859-1" ?><HDR><TABLE><RECORD><ITEM>
<ID>0x002D1247</ID><VALUE><![CDATA[file name]]></VALUE>
<HELP_STR_1><![CDATA[Filename of the last backup performed]]></HELP_STR_1>
<HELP_STR_2><![CDATA[This text field can hold 119 characters.]]></HELP_STR_2></ITEM>
<ITEM><ID>0x002D1248</ID><VALUE><![CDATA[2007/11/17 21:06:53]]></VALUE>
<HELP_STR_1><![CDATA[Date and time of the last backup performed]]></HELP_STR_1>
<HELP_STR_2><![CDATA[Item attribute: min(), max(2900/12/31 23:59:59).]]></HELP_STR_2></ITEM>
<ITEM><ID>0x002D1249</ID><VALUE><![CDATA[file name]]></VALUE>
<HELP_STR_1><![CDATA[Filename of the last restore performed]]></HELP_STR_1>
<HELP_STR_2><![CDATA[This text field can hold 119 characters.]]></HELP_STR_2></ITEM>
<ITEM><ID>0x002D124A</ID><VALUE><![CDATA[2007/09/10 01:57:23]]></VALUE>
<HELP_STR_1><![CDATA[Date and time of the 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 the current backup or restore operation]]></HELP_STR_1>
<HELP_STR_2><![CDATA[This item has 21 options available.]]></HELP_STR_2></ITEM>
<ITEM><ID>0x002D124D</ID><VALUE><![CDATA[0]]></VALUE>
<HELP_STR_1><![CDATA[Progress of the current backup or restore 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>

Note See the notes in the backup and restore commands for more information on intended use. See Backup
Command, on page 11 and Restore Command, on page 13.

Legacy CDT Upload Command

Table 6: Command Details

Command Detail Description

Command URL -F cdtfile=@"cdt_file_path/cdt_file_name"
"https://192.168.0.1/ws/v1/cdt_upload.html"

Command Information Upload a CDT file to the device.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
15
 API Definitions
Legacy CDT Upload Command

Command Detail Description

HTTP Method POST

Access Type Write

Access Level Guest, User, Admin

Example of issuing the upload CDT file command (assuming the filename is NTRP.cdt):
Input:
curl -k -X POST -H "X-SESSION-ID: $token" -F cdtfile=@"C:/myfiles/NTRP.cdt"
"https://192.168.0.1/cdt_upload.html?cdtfile=NTRP.cdt"
Expected output:
<html><body></body></html>

Chunky CDT Upload Command

Important Due to memory constraints, in Version 2.75 or later, the traditional single command line curl variant of
the CDT Upload command may fail with some builds. The following describes the support for "ChunkyDL"
which requires the Client software to break up the source file into more manageable chunks, and issue
sequential POST commands to achieve the full CDT File Upload without incurring significant memory
allocation on the target.

Curl command line only supports the –F option to send multi-part HTML form body content. The command
line does not have a built-in method of streaming single file content in chunks of data. The –F option puts the
entire file into a single buffer, before sending the content out in a single POST operation.

Note Unlike bash scripting with the Curl command 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.

In order to overcome the command line limitation, client software which runs from a bash shell may use a
bash shell based script to implement the following algorithm:
• Source file must be broken up into many files, with a maximum size of 10 MB (10*1024*1024) each.
This requirement may be met by pre-processing the source cdt file with the bash shell split command.
The "split.exe" command is available and installed on Windows client systems, using the default cygwin64
distribution.
• Each POST operation maintains the same –F file command line syntax, with the addition of a new header
that must be patched by the client script for each POST call. This header has three inputs per chunk (for
example, POST command): start offset byte (within the source file), end offset byte (included in the size
of the current chunk), and total source file size (in bytes).

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
16
API Definitions
Legacy CDT Upload Command

• Multi-POST command sequencing uses this new Content-Range header to be added to the command
line syntax that indicates to the target that the received "chunk" is one of many. The Content-Range
header 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

Table 7: Command Details

Command Detail Description

Algorithm and Commands Determine support for Chunky Download feature (see <LINK>).
This description uses pseudo code to If not supported, revert to use the legacy CDT upload command.
illustrate logic requirements. A working For more information, see Legacy CDT Upload Command, on page
15.
bash script will be available from
D9800 Engineering, prior to Version mkdir split_cdt_files_path
2.75. cd split_cdt_files_path
cp cdt_files_path/cdt_file_name .
split –d –b 10485760 cdt_file_name
result will be files x00, x01, x02, and so on.
$src_file-size=size of cdt_file_name contents (in bytes)
$start_offset=0
for each file x## in split_cdt_files_path
{
$end_offset=$start_offset+(size of x## file in bytes – 1)
$compensated_content_length=182 +
($end_offset + 1) – $start_offset
POST
-H "Content-Range: [start_offset]-[end_offset]/[src_file_size]"
-H "Content-Length: [compensated-content-length]
-F cdt file=@"split_cdt_files_path/current_chunk_file_name"
"https://192.168.0.1/ws/v1/cdt_upload.html"
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 syntax requirements
described here. Those languages support source file streaming into
a buffer, and the contents of the buffer is an input to the client
application specific HTTP(S) POST API implementation.

Command Information Upload a CDT file to the device using Chunky algorithm.

HTTP Method POST

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
18
API Definitions
Legacy CDT Upload Command

Command Detail Description

Access Type Write

Access Level Guest, User, Admin

Example of the POST content that needs to be sent for each chunk is as follows:
POST / HTTP/1.1..Host: 10.1.1.1\r\n
Accept: */*\r\n
X-SESSION-ID: 1234567890\r\n // actual value of logon sessionid would be here
Content-Range: bytes 0-10485759/12659933\r\n // different for each chunk
Content-Length: 10485942\r\n // range end_ size plus fixed 182 byte overhead
Content-Type: multipart/form-data;boundary=----------------------------9d4ffbe5a6c7\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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/device_ctl/download

Command Information Show information about download command.

HTTP Method GET, POST

Access Type Read, Write

Access Level Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
19
 API Definitions
Legacy CDT Upload Command

Table 9: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

dlmode (optional) Filter output based on the dlmode value.
Type: String
Values: Always (default), Never, Once
Select how to handle unforced over-air downloads:
• Always - Accept download, but not reboot.
• Once - Accept one download then reboot and change the mode
to Never.
• Never - Reject unforced over-air downloads.

A POST change of this setting will be persistent in non-volatile

memory (after reboots). A Factory Reset will reset this setting to
the default value.
Note We recommend that you do not change this setting from
its default value.
dlhttpchunk (optional) Inform external tool or curl based command line script if CDT
upload should use the multi-chunk algorithm.
(Read Only)
Type: String
Values: Enabled (default), Disabled (for testing only)
This value is read-only and intended only for use by specific internal
tools in Cisco test and manufacturing. It is not used by the D9800
Web UI, which is integrated within the target application software
during fie upload.

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 other numbers indicate older software, where command is not implemented.)
HTTP/1.1 404 Not Found
Date: Mon, 25 Sep 2017 13:30:40 GMT
Server: Hiawatha v10.3
Connection: keep-alive
Transfer-Encoding: chunked
In this case, we always expect the client software to use the Legacy CDT Upload command.
Example (Retrieve Download Feature support using Version 2.75 or later):
Input (XML case):
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 for 200 OK):
HTTP/1.1 200 OK
Date: Mon, 25 Sep 2017 13:33:04 GMT
Server: Hiawatha v10.3

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
20
 API Definitions
Upload Software License File Command

Connection: keep-alive
Transfer-Encoding: chunked
Content-type: application/xml

<?xml version="1.0" encoding="ISO-8859-1"

?><devicectl><download><settings><dlmode>Always</dlmode><dlhttpchunk>Enabled</dlhttpchunk></settings></download></devicectl>
Input (JSON case):
curl -i -k -H "X-SESSION-ID: $token" "http://192.168.0.1/ws/v2/device_ctl/download&js"
Expected output (Full HTTP response must be checked for 200 OK):
HTTP/1.1 200 OK
Date: Mon, 25 Sep 2017 13:39:30 GMT
Server: Hiawatha v10.3
Connection: keep-alive
Transfer-Encoding: chunked
Content-type: application/json

{
"devicectl": {
"download": {
"settings": {
"dlmode": "Always",
"dlhttpchunk": "Enabled"
}
}
}
}
Logic 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 Details

Command Detail Description

Command URL -F cdtfile=@"lic_file_path/lic_file_name"
"https://192.168.0.1/cdt_upload.html"

Command Information Software license files can be uploaded to the unit, the same as a
CDT file.

HTTP Method POST

Access Type Write

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
21
 API Definitions
Diagnostics Package (Export Debug File) Commands

Command Detail Description

Access Level Guest, User, Admin

Example of issuing the upload license file command (assuming the filename is D9800_lic.cdt):
Input:
curl -k -X POST -H "X-SESSION-ID: $token" -F cdtfile=@"C:/myfiles/D9800_lic.cdt"
"https://192.168.0.1/cdt_upload.html?cdtfile=D9800_lic.cdt"
Expected output:
<html><body></body></html>

Diagnostics Package (Export Debug File) Commands

Client Software Requirements:
Diagnostics package preparation may take several minutes, depending on hardware configuration, licensed
features, and log complexity. You can no longer use one command to perform a request, wait for the results
of the package generation, 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

Command Detail Description

Command URL https://192.168.0.1/ws/v1/diagnostics/trigger

Command Information Generate the diagnostics package file.

HTTP Method POST

Access Type Write

Access Level User, Admin

Restricted to lock level 0 only.

Options: N/A
Example of issuing the diagnostics trigger command:

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
22
API Definitions
Diagnostics Package (Export Debug File) Commands

Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/diagnostics/trigger"
Expected output (for success case, which indicates only the specified Diag Package Preparation was started):
<?xml version="1.0" encoding="ISO-8859-1"
?><SESSIONINFO><STATUS>Success</STATUS></SESSIONINFO>
Expected output (for fail case, which indicates that the Diag Package Preparation was not started):

Note You may request additional failure reason details by using the DIAGSTAT API.

<?xml version="1.0" encoding="ISO-8859-1" ?><SESSIONINFO><STATUS>response failure,

rc=192512</STATUS></SESSIONINFO>

Diagnostics Package Operation Status Command

Table 12: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v1/table?t=DIAGSTAT

Command Information Return information about Export Debug File (Diagnostics Package
preparation) status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Example of issuing the DIAG Status command:

Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/table?t=DIAGSTAT"
Expected output (example of when diagnostics package preparation is in progress):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><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 Support Data operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This
item has 6 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CF</ID><VALUE><![CDATA[43]]></VALUE
><NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress 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>
Expected output (example of when diagnostics package preparation is 100% completed successfully):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D25CD</ID><VALUE><![CDATA[Pass]]></VALUE><NAME><!
[CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent
operation passed, failed, or is in progress]]></HELP_STR_1><HELP_STR_2><![CDATA[This
item has 3 options

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
23
 API Definitions
Diagnostics Package (Export Debug File) Commands

available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CE</ID><VALUE><![CDATA[Done]]>
</VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of the current
Export Debug Support Data operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 6
options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CF</ID><VALUE><![CDATA[100]]></VALUE><NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress
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>
Expected output (example of when diagnostics package preparation fails, and detailed reason why it
failed):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D25CD</ID><VALUE><![CDATA[Fail]]></VALUE><NAME><![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates
whether the most recent operation passed, failed, or is in
progress]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 3 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CE</ID><VALUE><![CDATA[Lock level too
high for Export Debug Support Data
operation]]></VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of
the current Export Debug Support Data operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This
item has 6 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D25CF</ID><VALUE><![CDATA[20]]></VALUE><NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress
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 calling this API every 5 seconds, while the Inprogress state
is active, and until the OPERSTATUS is Pass and the PERCENTCOMPLETE is 100 or the OPERSTATUS
is Fail. The first call should wait a minimum of 10 seconds, after the diagnostics trigger API, to allow the
internal states to clear. If, at any time, the OPERSTATUS is Fail, then the client software should abort additional
checking and report the last DETAILEDSTATUS.

Diagnostics Package Retrieval Command

Table 13: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v1/diagnostics

Command Information Retrieves the diagnostics package file.

HTTP Method GET

Access Type Read

Access Level User, Admin

Restricted to Lock Level 0 only.

Options: NA
Example of issuing the diagnostics package retrieval command:
Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/diagnostics" -o diagnostics
Expected output (example for success case, which indicates that Diag Package Retrieval was completed):
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
24
 API Definitions
Status API

100 5599k 0 5599k 0 0 4691k 0 --:--:-- 0:00:01 --:--:-- 4693k

File name for retrieved file will be as per the –o parameter string (eg. file is
called "diagnostics" in this example) in the command invokation.
Expected output (example for fail case, which indicates that Diag Package Retrieval could not be
completed):

Note Additional failure reason details may be determined by calling the DIAGSTAT API.
<?xml version="1.0" encoding="ISO-8859-1" ?><SESSIONINFO><STATUS>response failure,
rc=192512</STATUS></SESSIONINFO>

Status API
This section describes the commands used to obtain input, output, and decode status information on the D9800
receiver.

RF Input Status Command

Table 14: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/input

Command Information Return information about RF input.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/input/rf?js=1"

URI Parameters (extension to the Command URL separated by /): N/A

Table 15: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

port (Key) Input port status to be returned.
Type: Integer
Values: 1..16 [NFE1 : 1..4, NFE2: 5..8, NFE3: 9..12, NFE4: 12..16]
Note This does not refer to the NTC Ethernet ports, it refers
specifically to the RF ports.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
25
 API Definitions
RF Input Status Command

URI Argument Description

stream (Key) Multi Input Path Stream ID. If not specified, default value of 1 is
used.
Optional
Type: Integer
Values: 1..6

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

Table 16: Output Field Descriptions

Output Field Description

dnlkfreq Downlink Frequency
Type: Float
Values: 0.0..15.0

symrate Symbol Rate

Type: Float
Values: 1.0..45.0

fec FEC Mode

Type: String
Values: "Auto", "1/2", "2/3", "3/4", "5/6", "7/8", "8/9"

mod Modulation Type

Type: String
Values: "DVBS" or "DVB-S2"

rolloff Rolloff Factor

Type: String
Values: ".20", ".25", ".35", "Auto"

iq IQ Mode
Type: String
Values: "Normal" or "Opposite"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
26
API Definitions
RF Input Status Command

Output Field Description

pwr LNB Power
Type: String
Values: "Off", "13V", "18V", "H-NIT", "V-NIT"

sel22khz 22 KHz Selection

Type: String
Values: "Off", "On", "Auto"

lO1 LO Select 1
Type: Float
Values: 0.0 … 15.0

lO2 LO Select 2
Type: Float
Values: 0.0 … 15.0

xover Cross Over Frequency

Type: Float
Values: 0.0 … 15.0

pol Polarization
Type: String
Values: “Horizontal”, “Vertical”, “Auto”

orbpos Orbital Position

Type: Float
Values: 0.0 ... 360.0

ewflag East West Flag

Type: String
Values: "N/A", "East", "West"

afcrange AFC Range Value

Type: Float
Values: 0.0 ... 5.0

acqmode PSI Acquisition Mode

Type : String
Values : "Auto", "Basic", "Custom"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
27
 API Definitions
RF Input Status Command

Output Field Description

satlock Satellite Lock
Type: String
Values: "No Lock", "Lock-Sig" or "Lock+Sig"

inputrate Input Rate

Type: Integer
Values: 0…4294967295

netname Network Name

Type: String
Values: Up to 64 characters

netid Network ID
Type: Integer
Values: 0…65535

transid Transport ID
Type: Integer
Values: 0…65535

lsttunerea Last Tune Reason

Type: String
Values: "No_Change", "DR Change", "User_Change",
"Preset_Change", "Uplink_Change", or "NIT_TS_Change"

tunereason Last Tune Reason

Type: String
Values: Up to 24 characters

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (S./W Release 2.75 and up)

Type : String
Values : "Rigorous", "Relaxed"
Note Service List Mode (Version 2.50 and
earlier)
Type : String
Values : "Rigorous", "Degraded"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
28
API Definitions
RF Input Status Command

Output Field Description

baten Enable BAT Reception
Type: String
Values: "Yes", "No"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

Input Example:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/input/rf?js=1"
Expected output (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",
"paten": "Yes"
},

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
29
 API Definitions
RF Input Status Command

{
"port": "2",
"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": "Lock+Sig",
"inputrate": "0.0",
"netname": "Effete",
"netid": "1",
"transid": "201",
"lsttunerea": "User_Change",
"tunereason": "User",
"freqmode": "NIT",
"svclstmode": "Rigorous",
"baten": "No",
"niten": "Yes",
"sdten": "No",
"paten": "No"
},
{
"port": "3",
"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",
"mod": "8PSK DVB-S2",
"rolloff": ".35",
"iq": "Normal",
"pwr": "Off",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
30
 API Definitions
ASI Input Status Command

"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"
}
]
}
}

ASI Input Status Command

Table 17: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/input/asi

Command Information Return information about ASI input.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/input/asi?js=1"

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
31
 API Definitions
ASI Input Status Command

Table 18: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

port Input Port status to be returned
Type: Integer
Values: 1..2
Note This does not refer to the NTC Ethernet ports, it refers
specifically to the ASI ports.
stream (optional) Multi Input Path. If not specified, default value of 1 is used.
Type: Integer
Values: 1

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

Table 19: Output Field Descriptions

Output Field Description

asilock ASI Signal Lock
Type: String
Values: "Lock" or "NoLock"

inputrate Input Rate

Type: Integer
Values: 0…4294967295

netname Network Name

Type: String
Values: Up to 64 characters

netid Network ID
Type: Integer
Values: 0…65535

transid Transport ID
Type: Integer
Values: 0…65535

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
32
API Definitions
ASI Input Status Command

Output Field Description

scrambmode Scrambling Mode
Type: String
Values: "Unk", "DES", "DVB", "BISS1", "BISS2", or "BISS3"

transerr Transport Error

Type: String
Values: "Ok", "Error", or "N/A"

asilinkerr ASI Link Error

Type: String
Values: "Ok", "Error", or "N/A"

asipktsize ASI Packet Size

Type: String
Values: "188", "204", or "N/A"

lsttunerea Last Tune Reason

Type: String
Values: "No_Change", "DR Change", "User_Change",
"Preset_Change", "Uplink_Change", or "NIT_TS_Change"

tunereason Last Tune Reason

Type: String
Values: Up to 24 characters

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

• Type: String
• Values: "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
33
 API Definitions
ASI Input Status Command

Output Field Description

baten Enable BAT Reception
Type: String
Values: "Yes", "No"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

Input Example:
curl -k -H "X-SESSION-ID: $token" "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 RESTful Web Services API Reference Guide
34
 API Definitions
IP Input Status Command

IP Input Status Command

Table 20: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/input/moip

Command Information Return information about MOIP input.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/input/moip?js=1"

URI Parameters (extension to the Command URL separated by /): N/A

Table 21: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (optional) Multi Input Path Stream ID. If not specified, default value of 1 is used.
Type: Integer
Values: 1..32

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

Table 22: Output Field Descriptions

Output Field Description

port Input Port status to be returned
Type: Integer
Values: 1

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
35
 API Definitions
IP Input Status Command

Output Field Description

moiplock MOIP Signal Lock
Type: String
Values: "Lock" or "NoLock"

inputrate Input Rate

Type: Integer
Values: 0…4294967295

netid Network ID
Type: Integer
Values: 0…65535

transid Transport ID
Type: Integer
Values: 0…65535

scrambmode Scrambling Mode

Type: String
Values: "Unk", "DES", "DVB”", "BISS1", "BISS2", or "BISS3"

transerr Transport Error

Type: String
Values: "Ok", "Error", or "N/A"

iplinkstat IP Link Status

Type: String
Values: "Down" or "Up"

ipsignal IP Signal
Type: String
Values: "None" or "Active"

feclock FEC Lock

Type: String
Values: "None", "Column", "Row", or "Collision"

pcrlock PCR Lock

Type: String
Values: "Yes" or "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
36
API Definitions
IP Input Status Command

Output Field Description

dejitlaten Dejitter Latency
Type: Integer
Values: 0…4294967295

datasrc1 Data Source 1

Type: String
Values: IP address in the dot format, for example, 192.131.244.10

datasrc2 Data Source 2

Type: String
Values: IP address in the dot format, for example, 192.131.244.10

data1tstyp Data 1 transport Type

Type: String
Values: "Unk", "UDP", or "RTP"

data2tstyp Data 2 transport Type

Type: String
Values: "Unk", "UDP", or "RTP"

lsttunerea Last Tune Reason

Type: String
Values: "No_Change", "DR Change", "User_Change",
"Preset_Change", "Uplink_Change", or "NIT_TS_Change"

tunereason Last Tune Reason

Type: String
Values: Up to 24 characters

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
37
 API Definitions
IP Input Status Command

Output Field Description

baten Enable BAT Reception
Type: String
Values: "Yes", "No", or "N/A"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

Input Example:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/input/moip?js=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"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
38
 API Definitions
ABR Input Status Command

ABR Input Status Command

Table 23: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/input/abr

Command Information Return information about ABR input.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/input/abr?js=1"

Table 24: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (key) Multi Input Path
Type: Integer
Values: 1...32

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

Table 25: Output Field Descriptions

Output Field Description

act Input is activated
Type: String
Values: "Yes" or "No"

abrlock ASI Signal Lock

Type: String
Values: "No Lock", "Lock-Sig", "Lock+Sig"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
39
 API Definitions
ABR Input Status Command

Output Field Description

iplinkstat ABR Ethernet link status
Type: String
Values: "Down", "Up"

ipsignal ABR Signal Encapsulation Lock Status

Type: String
Values: "None", "Active"

inputrate Bit rate of the input transport stream

Type: Float
Values: 0…4294.967295 Mbps

netname Network Name

Type: String
Values: Up to 64 characters

netid Network ID
Type: Integer
Values: 0…65535

transid Transport ID
Type: Integer
Values: 0…65535

scrambmode Scrambling Mode

Type: String
Values: "Unk", "DES", "DVB", "BISS1", "BISS2", or "BISS3"

lsttunerea Last Tune Reason

Type: String
Values: "No_Change", "DR Change", "User_Change",
"Preset_Change", "Uplink_Change", or "NIT_TS_Change"

tunereason Last Tune Reason

Type: String
Values: Up to 24 characters

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
40
API Definitions
ABR Input Status Command

Output Field Description

svclstmode 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"

baten Enable BAT Reception

Type: String
Values: "Yes", "No", or "N/A"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

rate Bit rate of the input transport stream

Type: Float
Values: 0…4294.967295 Mbps

dlrate Dowload bitrate of the input transport stream

Type: Float
Values: 0…4294.967295 Mbps

buflvlcurq1 Buffer level current queue 1

Type: Float
Values: 0…4294.967295 Mb

buflvlcurq2 Buffer level current queue 2

Type: Float
Values: 0…4294.967295 Mb

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
41
 API Definitions
ABR Input Status Command

Output Field Description

manidur Manifest duration
Type: Integer
Values: 0…4294967295 seconds

manierr Manifest parsing errors

Type: Integer
Values: 0…4294967295

dlmanicnt Manifest download count

Type: Integer
Values: 0…4294967295

dlmanierr Manifest download error

Type: Integer
Values: 0…4294967295

dlfragcnt Download fragment count

Type: Integer
Values: 0…4294967295

dlfragerr Download fragment errors

Type: Integer
Values: 0…4294967295

fragerr Fragment parsing errors

Type: Integer
Values: 0…4294967295

dlcurminlat Download stop time from the end of manifest

Type: Integer
Values: 0…4294967295

dlcurtrglat Download start time from the beginning of manifest

Type: Integer
Values: 0…4294967295

Input Example:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/input/abr?js=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
42
API Definitions
ABR Input Status Command

Expected output (values are for example purposes only):

{
"input": {
"abr": [
{
"stream": "1",
"act": "Yes",
"abrlock": "No Lock",
"iplinkstat": "Down",
"ipsignal": "None",
"inputrate": "0.0",
"netname": "",
"netid": "1",
"transid": "",
"scrambmode": "Unk",
"lsttunerea": "No_Change",
"tunereason": "User",
"freqmode": "User Cfg",
"svclstmode": "Relaxed",
"baten": "N/A",
"niten": "N/A",
"sdten": "No",
"paten": "No",
"acqstatus": "Failed",
"name": "ABR1",
"rate": "0",
"dlrate": "0.0",
"buflvlcurq1": "0.0",
"buflvlcurq2": "0.0",
"manidur": "0",
"manierr": "0",
"dlmanicnt": "0",
"dlmanierr": "0",
"dlfragcnt": "0",
"dlfragerr": "0",
"fragerr": "0",
"dlcurminlat": "0",
"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",
"dlmanicnt": "0",
"dlmanierr": "0",
"dlfragcnt": "0",
"dlfragerr": "0",
"fragerr": "0",
"dlcurminlat": "0",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
43
 API Definitions
Zixi Input Status Command

"dlcurtrglat": "0"
}
]
}
}

Zixi Input Status Command

Table 26: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/input/zixi

Command Information Return information about ZIXI input.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/input/zixi?js=1"

URI Parameters (extension to the Command URL separated by /): N/A

Table 27: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (key) Multi Input Path.
Type: Integer
Values: 1...32

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
44
API Definitions
Zixi Input Status Command

Table 28: Output Field Descriptions

Output Field Description

act Input is activated
Type: String
Values: "Yes" or "No"

abrlock Zixi Signal Lock

Type: String
Values: "No Lock", "Lock-Sig", "Lock+Sig"

iplinkstat Zixi Ethernet link status

Type: String
Values: "Down", "Up"

ipsignal Zixi Signal Encapsulation Lock Status

Type: String
Values: "None", "Active"

inputrate Bit rate of the input transport stream

Type: Float
Values: 0…4294.967295 Mbps

netname Network Name

Type: String
Values: Up to 64 characters

netid Network ID
Type: Integer
Values: 0…65535

transid Transport ID
Type: Integer
Values: 0…65535

scrambmode Scrambling Mode

Type: String
Values: "Unk", "DES", "DVB", "BISS1", "BISS2", or "BISS3"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
45
 API Definitions
Zixi Input Status Command

Output Field Description

lsttunerea Last Tune Reason
Type: String
Values: "No_Change", "DR Change", "User_Change",
"Preset_Change", "Uplink_Change", or "NIT_TS_Change"

tunereason Last Tune Reason

Type: String
Values: Up to 24 characters

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode

Type: String
Values: "Rigorous", "Degraded"

baten Enable BAT Reception

Type: String
Values: "N/A", "Yes", "No"

niten Enable NIT Reception

Type: String
Values: "N/A", "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "N/A", "Yes", "No"

paten Enable PAT Reception

Type String
Values: "N/A", "Yes", "No"

acqstatus Acquisition State

Type: String
Values: "Full", "Partial", "None"

inputid Input Id
Type: String
Values: "ZIXI1", "ZIXI2"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
46
API Definitions
Zixi Input Status Command

Output Field Description

reconn Zixi reconnections
Type: Integer
Values: 0…65535

arqrec Zixi packets recovered by ARQ (Automatic Repeat Request)

Type: Integer
Values: 0…65535

fecrec Zixi packets recovered by FEC (Forward Error Correction)

Type: Integer
Values: 0…65535

notrec Zixi packets not recovered

Type: Integer
Values: 0…65535

rowstatus Zixi input row status

Type: String
Values: "Active", "Inactive"

cursrc Zixi source currently connected

Type: String
Values: "zixi://tor02lab-s-002.cisco.com:2077/cisco-BBB", for
example

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": "User_Change",
"tunereason": "User",
"freqmode": "User Cfg",
"svclstmode": "Relaxed",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
47
 API Definitions
PE Status Command

"baten": "N/A",
"niten": "N/A",
"sdten": "No",
"paten": "Yes",
"acqstatus": "Partial",
"inputid": "ZIXI1",
"reconn": "0",
"arqrec": "0",
"fecrec": "0",
"notrec": "0",
"rowstatus": "Active",
"cursrc": "zixi://tor02lab-s-002.cisco.com:2077/cisco-BBB"
}
}
}

PE Status Command
Table 29: Command Details

Command Detail Description

Command URL ttps://192.168.0.1/ws/v2/status/pe

Command Information This command is used to display PE status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax Examples 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"

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 &)

URI Argument Description

peid (key) Program Entry Identifier
Type: Integer
Value: 1..32

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
48
API Definitions
PE Status Command

URI Argument Description

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

Table 31: Output Field Descriptions

Output Field Description

Chn Channel Number to be configured on this Program Entry.
Type: Integer
Values: 0..65535

chname Channel Name

Type: String
Values: String used to describe the channel name, less than 64
characters

caauth CA authorized
Type: String
Values: "Yes", "No"

caencrypt CA Encrypted
Type: String
Values: "Yes", "No"

cascramble CA Scrambled
Type: String
Values: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
49
 API Definitions
PE Status Command

Output Field Description

caid CA identifier
Type: String
Values: "Unknown", "FTA", "SA", "BISS1", "BISS2", "BISS3",
"Standardized", "Canal Plus", "CCETT", "Deutsche Tel",
"Eurodec", "France Tel", "Irdeto", "Jerrold GI", "Matra Comm",
"NDS", "Nokia", "Norwegian Tel", "Ntl", "Philips", "Sony",
"Tandberg Tv", "Thomson", "TV Com", "HPT Croatian", "HRT
Croatian", "IBM", "NERA", "Beta Technik", "Kudelski", "Titan
IS", "Telfonica", "Stentor", "Tadiran Scopus", "Barco", "Starguide
DN", "Mentor DS", "European", "Polycipher", "General Ins",
"Telemann", "Cryptoworks", "Tsinghua", "Easycas", "Alphacrypt",
"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"

prgmstatus program status

Type: String
Values: "Active", "Inactive"

pmtpid PMT pid

Type: Integer
Values: 0…8192

pcrpid PCR pid

Type: Integer
Values: 0…8192

srstatus SR Status
Type: String
Values: "Not Started", "Primary", "Alternate"

srtype SR Type
Type: String
Values: "None", "Scheduled", "CA", "Cue Trigger"

srstartime SR start time

Type: Time
Values: for example, "2007/09/01 00:00:00"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
50
API Definitions
PE Status Command

Output Field Description

srendtime SR end time
Type: Time
Values: for example, "2007/09/01 00:00:00"

peenabled PE enabled
Type: String
Values: "Yes", "No"

hdlicensed HD Licensed
Type: String
Values: "Yes", "No"

chsource Channel source

Type: String
Values: "User", "First Chan", "LEC", "ADP Force Tune", "DR",
"SR", "Powerup"

Input Example (request XML output):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/pe?peid=1"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?><pe><record><peid>1</peid><chn>801</chn>
<inp>RF2</inp><chname>Effete H.264
1080i</chname><caauth>Yes</caauth><caencrypt>Yes</caencrypt>
<cascramble>Yes</cascramble><caid>SA</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 (values are for example purposes only):
{
"pe": {
"record": {
"peid": "1",
"chn": "801",
"inp": "RF2",
"chname": "Effete H.264 1080i",
"caauth": "Yes",
"caencrypt": "Yes",
"cascramble": "Yes",
"caid": "SA",
"prgmstatus": "Active",
"pmtpid": "5801",
"pcrpid": "2100",
"srstatus": "Primary",
"srtype": "None",
"srstartime": "2007/09/01 00:00:00",
"srendtime": "2007/09/01 00:00:00",
"peenabled": "Yes",
"hdlicensed": "No",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
51
 API Definitions
CA PowerVu Status Command

"chsource": "User"
}
}
}

CA PowerVu Status Command

Table 32: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/ca/pvu

Command Information This command returns (or clears counters for) PowerVu Status
information.

HTTP Methods GET (All Access), POST (Restricted Access)

Access Type Read (Display Details), Write (Clear Counters)

Access Level Guest (Read Only), User (Read/Write), Admin (Read/Write)

Clear Counters Syntax POST "https://192.168.0.1/ws/v2/status/ca/pvu/clear"

Display Details Syntax GET "https://192.168.0.1/ws/v2/status/ca/pvu"

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 &)

URI Argument Description

clear Clear all counters.

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
52
API Definitions
CA PowerVu Status Command

Table 34: Output Field Descriptions

Output Field Description

iseuseradd ISE User Address
encpktpass Encrypted ADP Packets Passed
Type: Integer
Value: 0…0xFFFFFFFF

encpktrcv Encrypted ADP Packets Received

Type: Integer
Value: 0…0xFFFFFFFF

nencpktpass Non-Encrypted ADP Packets Passed

Type: Integer
Value: 0…0xFFFFFFFF

nencpktrcv Non-Encrypted ADP Packets Received

Type: Integer
Value: 0…0xFFFFFFFF

Input Example (request XML default format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/pvu"
Expected output (values 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: $token" "https://192.168.0.1/ws/v2/status/ca/pvu?js=1"
Expected output (values are for example purposes only):
{
"ca": {
"pvu": [
{
"iseuseradd": "000-529-2431-6",
"encpktpass": "10490",
"encpktrcv": "10490",
"nencpktpass": "8390",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
53
 API Definitions
CI (Common Interface) CAM Status Command

"nencpktrvc": "8390"
},
{
"iseuseradd": "000-529-2432-3",
"encpktpass": "10388",
"encpktrcv": "10388",
"nencpktpass": "8392",
"nencpktrvc": "8392"
}
]
}
}

CI (Common Interface) CAM Status Command

Table 35: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/ca/ci

Command Information Return information about Common Interface (CI) CAMs.

HTTP Methods GET (All Access), POST (Restricted Access)

Access Type Read

Access Level Guest, User, Admin

Display Details Syntax GET "https://192.168.0.1/ws/v2/status/ca/ci"

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 &)

URI Argument Description

slot CI CAM Slot
Type: String
Value: "TOP", "BOTTOM"

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
54
API Definitions
CI (Common Interface) CAM Status Command

Table 37: Output Field Descriptions

Output field Description

camstatus CAM Status in this slot
Type: String
Value: "Not Read", "Ready"

sysname CAM System Name

Type: String
Value: Character String (Varies based on type of CAM inserted
in the slot)

compname CAM Company Name

Type: String
Value: Character string of inserted CAM name

mfgcode CAM Manufacture Code

Type: Integer
Value: 0…0xFFFFFFFF

mfgid CAM Manufacture Identifier

Type: Integer
Value: 0…0xFFFFFFFF

serialno CAM Serial Number

Type: String
Value: Inserted CAM Serial number in string format (max 63
characters)

hwver CAM Hardware Version

Type: String
Value: Inserted CAM Hardware Version in string format

appver CAM Application Version

Type: String
Value: Inserted CAM Application Version in string format

prodcode CAM Product Code

Type: Integer
Value: 0...0xFFFFFFFF

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
55
 API Definitions
CISYS Status Command

Input Example:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/ci"
Expected output (values are for example purposes only):
<ca>
<ci>
<slot>
<slotid>TOP</slotId>
<camstatus>Ready</camstatus>
<sysname>Irdeto Aston 2.1510</sysname>
…..
</slot>
<slot>
<slotId>BOTTOM</slotid>
<camstatus>Not Ready</camstatus>
<sysname> </sysname>
</slot>
</ci>
</ca>
Get Status for TOP slot in JSON format:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/ci?slot=TOP&js=1"
Expected output (values are for example purposes only):
{
"ca": {
"ci": {
"slot": "TOP",
"camstatus": "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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/ca/cisys

Command Information Return information about Common Interface (CI) CAMs supported
System IDs.

HTTP Methods GET (All Access), POST (Restricted Access)

Access Type Read

Access Level Guest, User, Admin

Display Details Syntax GET "https://192.168.0.1/ws/v2/status/ca/cisys"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
56
API Definitions
CISYS Status Command

URI Parameters (extension to the Command URL separated by /): N/A

Table 39: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Table 40: Output Field Descriptions

Output Field Description

slotid CI CAM Slot
Type: String
Value: "TOP", "BOTTOM"

sysname CI System Name

Type: String
Value: CAM Supported System Name

sysid CAM Supported System ID

Type: String
Value: Inserted CAM supported System IDs

sysnameid CAM Supported System ID with Name

Type: String
Value: Inserted CAM supported System ID + Name

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):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<ca>
<cisys>
<slotid>TOP</slotid>
<sysids>2525</sysids>
<sysname>News Dataco</sysname>
<sysnameids>News Dataco (0x9dd)</sysnameids>
</cisys>
</ca>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
57
 API Definitions
Useraddr Status Command

Input example (request JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/cisys?js=1"
Expected output (values are for example purposes only):
{
"ca": {
"cisys": {
"slotid": "TOP",
"sysids": "2525",
"sysname": "News Dataco",
"sysnameids": "News Dataco (0x9dd)"
}
}
}

Useraddr Status Command

Table 41: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/ca/useraddr

Command Information Return user addresses from all ISE chips.

HTTP Methods GET (All Access), POST (Restricted Access)

Access Type Read

Access Level Guest, User, Admin

Display Details Syntax GET "https://192.168.0.1/ws/v2/status/ca/useraddr"

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 &)

URI Parameter Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
58
 API Definitions
Output Status Command

Table 43: Output Field Descriptions

Output Field Description

uaindex User address index within given chip (iseindex)
Type: Integer
Value: 1 to number of user addresses within unit

useraddr User Address

Type: String
Value: output in the form "nnn-nnn-nnnn-n"

Input Example (request XML format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/ca/useraddr"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/output

Command Information This command can be used to get all output status parameters.

HTTP Method GET

Access Type Read

Access Level User, Admin

Display Details Syntax GET "https://192.168.0.1/ws/v2/status/output"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
59
 API Definitions
Output Status Command

URI Parameters (extension to the Command URL separated by /): N/A

Table 45: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Input example (request XML format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?><output><asi><rate>78.535733</rate>
<free>0.0</free><pid><peid>1</peid><row>1</row><inpid>1500</inpid><outpid>1500</outpid>
<inchan>1500</inchan><type>VID</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>2</row>
<inpid>3349</inpid><outpid>3349</outpid><inchan>3349</inchan><type>LSDT</type>
<received>Yes</received><pcr>No</pcr><scrambled>No</scrambled></pid>
<pid><peid>1</peid><row>3</row><inpid>4001</inpid><outpid>4001</outpid>
<inchan>4001</inchan><type>MPE</type><received>
No</received><pcr>No</pcr><scrambled>No</scrambled></pid><pid><peid>1</peid><row>4</row>
<inpid>4002</inpid><outpid>4002</outpid><inchan>4002</inchan><type>MPE</type>
<received>No</received><pcr>No</pcr><scrambled>No</scrambled></pid>
<pid><peid>1</peid><row>5</row><inpid>4003</inpid>
<outpid>4003</outpid><inchan>4003</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>6</row><inpid>4004</inpid><outpid>4004
</outpid><inchan>4004</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>7</row><inpid>4005</inpid><outpid>4005
</outpid><inchan>4005</inchan><type>MPE</type><received>No</received><pcr>No</pcr><scrambled>
No</scrambled></pid><pid><peid>1</peid><row>8</row><inpid>1550</inpid><outpid>1550</outpid>
<inchan>1550</inchan><type>DPI</type><received>No</received><pcr>No</pcr><scrambled>No</scrambled>
</pid><pid><peid>1</peid><row>9</row><inpid>2906</inpid><outpid>2906</outpid><inchan>2906</inchan>
<type>VBI</type><received>No</received><pcr>No</pcr><scrambled>No</scrambled></pid><pid><peid>1
</peid><row>10</row><inpid>1511</inpid><outpid>1511</outpid><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</scrambled></pid><pid><peid>1</peid><row>13</row><inpid>1113
</inpid><outpid>1113</outpid><inchan>1113</inchan><type>AUD</type><received>Yes</received>
<pcr>No</pcr><scrambled>No</scrambled></pid><pid><peid>1</peid><row>14</row><inpid>2750</inpid>
<outpid>2750</outpid><inchan>2750</inchan><type>SUBT</type><received>Yes</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><collision><status>No Record in Dynamic
Table</status></collision>
</asi><moip><enginerr>No</enginerr><overflow>No</overflow><comrate>68.5</comrate><ts1rate>0.0
</ts1rate><ts2rate>0.0</ts2rate><pid><peid>1</peid><row>1</row><inpid>1500</inpid><outpid>1500
</outpid><inchan>1500</inchan><type>VID</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>2</row><inpid>3349</inpid><outpid>3349
</outpid><inchan>3349</inchan><type>LSDT</type><received>Yes</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>3</row><inpid>4001</inpid><outpid>4001
</outpid><inchan>4001</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>4</row><inpid>4002</inpid><outpid>4002
</outpid><inchan>4002</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>5</row><inpid>4003</inpid><outpid>4003
</outpid><inchan>4003</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>6</row><inpid>4004</inpid><outpid>4004
</outpid><inchan>4004</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>7</row><inpid>4005</inpid><outpid>4005
</outpid><inchan>4005</inchan><type>MPE</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>8</row><inpid>1550</inpid><outpid>1550
</outpid><inchan>1550</inchan><type>DPI</type><received>No</received><pcr>No</pcr>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
60
API Definitions
Output Status Command

<scrambled>No</scrambled></pid><pid><peid>1</peid><row>9</row><inpid>2906</inpid><outpid>2906
</outpid><inchan>2906</inchan><type>VBI</type><received>No</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>10</row><inpid>1511</inpid><outpid>1511
</outpid><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</scrambled></pid><pid><peid>1</peid><row>13</row><inpid>1113</inpid><outpid>1113
</outpid><inchan>1113</inchan><type>AUD</type><received>Yes</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><pid><peid>1</peid><row>14</row><inpid>2750</inpid><outpid>2750
</outpid><inchan>2750</inchan><type>SUBT</type><received>Yes</received><pcr>No</pcr>
<scrambled>No</scrambled></pid><collision><status>No Record in Dynamic
Table</status></collision>
</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 for example purposes only):
{
"output": {
"asi": {
"rate": "78.535922",
"free": "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",
"inchan": "4001",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "4",
"inpid": "4002",
"outpid": "4002",
"inchan": "4002",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "5",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
61
 API Definitions
Output Status Command

"inpid": "4003",
"outpid": "4003",
"inchan": "4003",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "6",
"inpid": "4004",
"outpid": "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"
},
{
"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 RESTful Web Services API Reference Guide
62
API Definitions
Output Status Command

},
{
"peid": "1",
"row": "12",
"inpid": "1102",
"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"
}
},
"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 Services API Reference Guide
63
 API Definitions
Output Status Command

"inchan": "4001",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "4",
"inpid": "4002",
"outpid": "4002",
"inchan": "4002",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "5",
"inpid": "4003",
"outpid": "4003",
"inchan": "4003",
"type": "MPE",
"received": "No",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "6",
"inpid": "4004",
"outpid": "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 API Reference Guide
64
API Definitions
Output Status Command

"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"
},
{
"peid": "1",
"row": "12",
"inpid": "1102",
"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
65
 API Definitions
Output Status Command

ASI Output Status Command

Table 46: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/output

Command Information This command is used to get ASI Output status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/output/asi",

GET "https://192.168.0.1/ws/v2/status/output/asi1", or
GET "https://192.168.0.1/ws/v2/status/output/asi2"

Table 47: URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

asi/asi1/asi2 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.

Table 48: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
66
API Definitions
Output Status Command

Table 49: Output Field Descriptions

Output Field Description

rate Output Rate (Mbps)
Type: Float
Values: 0.0 ….. 206.0

free Free Bandwidth (Mbps)

Type: Float
Values: 0.0 ….. 206.0

Example on NTC single-stream unit, where no ASI output configured (request XML format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output/asi"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<output>
<asi>
<rate>0.0</rate>
<free>0.0</free>
<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",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "2",
"inpid": "3349",
"outpid": "3349",
"inchan": "3349",
"type": "LSDT",
"received": "Yes",
"pcr": "No",
"scrambled": "No"
},
{

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
67
 API Definitions
Output Status Command

"peid": "1",
"row": "3",
"inpid": "4001",
"outpid": "4001",
"inchan": "4001",
"type": "MPE",
"received": "Yes",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "4",
"inpid": "4002",
"outpid": "4002",
"inchan": "4002",
"type": "MPE",
"received": "Yes",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "5",
"inpid": "4003",
"outpid": "4003",
"inchan": "4003",
"type": "MPE",
"received": "Yes",
"pcr": "No",
"scrambled": "No"
},
{
"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 Web Services API Reference Guide
68
API Definitions
Output Status Command

"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"
},
{
"peid": "1",
"row": "12",
"inpid": "1102",
"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 Definitions
Output Status Command

MOIP Output Status

Table 50: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/output/moip

Command Information This command is used to get MOIP output status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/output/moip",

GET "https://192.168.0.1/ws/v2/status/output/moip1", or
GET "https://192.168.0.1/ws/v2/status/output/moip2"

Table 51: URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

moip/moip1/moip2 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.

Table 52: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
70
API Definitions
Output Status Command

Table 53: Ouput Field Descriptions

Output Field Description

enginerr Critical MOIP Engine Error
Type: Boolean
Values: "Yes" or "No"

overflow MOIP TS stream Overflow

Type: Boolean
Values: "Yes" or "No"

comrate Combined user rate (Mbps)

Type: Float
Values: 0.0 ….. 206.0

ts1rate Actual TS1 port user rate (Mbps)

Type: Float
Values: 0.0 ….. 206.0

ts2rate Actual TS2 port user rate (Mbps)

Type: Float
Values: 0.0 ….. 206.0

Example on NTC single-stream unit:

curl -k -H "X-SESSION-ID: $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</scrambled>
</pid>
<pid>
<peid>1</peid>
<row>2</row>
<inpid>2110</inpid>
<outpid>2110</outpid>
<inchan>2110</inchan>
<type>AUD</type>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
71
 API Definitions
Output Status Command

<received>Yes</received>
<pcr>No</pcr>
<scrambled>No</scrambled>
</pid>
<collision>
<status>No Record in Dynamic Table</status>
</collision>
</moip>
</output>
Example on NTC multi-stream unit:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output/moip1"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<output>
<moip1>
<enginerr>No</enginerr>
<overflow>No</overflow>
<comrate>68.5</comrate>
<ts1rate>0.0</ts1rate>
<ts2rate>0.0</ts2rate>
<pid>
<peid>1</peid>
<row>1</row>
<inpid>2100</inpid>
<outpid>2100</outpid>
<inchan>2100</inchan>
<type>VID</type>
<received>Yes</received>
<pcr>Yes</pcr>
<scrambled>No</scrambled>
</pid>
<pid>
<peid>1</peid>
<row>2</row>
<inpid>2110</inpid>
<outpid>2110</outpid>
<inchan>2110</inchan>
<type>AUD</type>
<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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/output/<level_1>/<level_2>

Command Information This command can be used to read all ASI/MOIP DPM PMT PID
Output Status parameters.
Note Partial response is not supported. This command returns
the status of all active peid and row key combinations for
all output fields for the specified MOIP or ASI.
HTTP Method GET

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
72
API Definitions
Output Status Command

Command Detail Description

Access Type Read

Access Level User, Admin

Syntax for getting MOIP status output GET "https://192.168.0.1/ws/v2/status/output/moip/pid",

parameters GET "https://192.168.0.1/ws/v2/status/output/moip1/pid", or
GET "https://192.168.0.1/ws/v2/status/output/moip2/pid"

Syntax for getting ASI status output GET "https://192.168.0.1/ws/v2/status/output/asi/pid",

parameters GET "https://192.168.0.1/ws/v2/status/output/asi1/pid", or
GET "https://192.168.0.1/ws/v2/status/output/asi2/pid"

Table 55: URI <level_1> URI Parameters (extension to the Command URL separated by /)

URI Level 1 Parameter Description

asi/asi1/as2 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.

moip/moip1/moip2 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 supported values are moip1 for IP output 1 and
moip2 for IP output 2.

Table 56: URI <level_2> URI Parameters (extension to the Command URL separated by /)

URI Level 2 Parameter Description

pid DPM PMT PID information.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
73
 API Definitions
Output Status Command

Table 57: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Table 58: Output Field Descriptions

Output Field Description

peid (Key) Program Entry ID
Type: Integer
Values: 1..32

row (Key) Identity of service in PMT

Type: Integer
Values: 1..64

inpid Input PMT Pid

Type: Integer
Values: 0 .. 8191

outpid Output PMT Pid

Type: Integer
Values: 0 .. 8191

type Stream Category

Type: String
Values: "INVL", "PCR", "VID", "AUD", "SUBT", "VBI", "DPI",
"MPE", "TTX", "DATA", "LSDT", "CDT", "ETV", "UNKN"

received Input Received

Type: Boolean
Values: "Yes", "No"

pcr PCR
Type: Boolean
Values: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
74
API Definitions
Output Status Command

Output Field Description

scrambled Output Scrambled
Type: Boolean
Values: "Yes", "No"

status Indicate the API output status

Type: String
Values: text to indicate the output status
Note The PID information is dynamic data. If there is no PID
information in UIC table, the "status" field will indicate
the reason.

ASI Example on NTC single-stream unit (for which ASI output was not 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": {
"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": "1",
"row": "2",
"inpid": "2210",
"outpid": "2210",
"type": "AUD",
"received": "Yes",
"pcr": "No",
"scrambled": "No"
},
{
"peid": "1",
"row": "3",
"inpid": "18",
"outpid": "18",
"type": "UNKN",
"received": "No",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
75
 API Definitions
Output Status Command

"pcr": "No",
"scrambled": "No"
}
]
}
}
}
MOIP example on NTC single-stream unit (for which MOIP output was configured):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output/moip/pid&js=1"
Expected output (values are for example purposes only):
{
"output": {
"moip": {
"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"
}
]
}
}
}
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",
"scrambled": ""
},
{
"peid": "1",
"row": "2",
"inpid": "2210",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
76
API Definitions
Output Status Command

"outpid": "2210",
"type": "AUD",
"received": "No",
"pcr": "No",
"scrambled": ""
},
{
"peid": "1",
"row": "3",
"inpid": "18",
"outpid": "18",
"type": "UNKN",
"received": "No",
"pcr": "No",
"scrambled": ""
}
]
MOIP Example on NTC multi-stream unit (for which MOIP1 output was configured):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/output/moip1/pid&js=1"
Expected output (values are for example purposes only):
{
"output": {
"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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/output/<level_1>/<level_2>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
77
 API Definitions
Output Status Command

Command Detail Description

Command Information This command is used to read all the ASI or MOIP DPM active
collision statuses.
Note Partial response is not supported. This command returns
the status of all active peid and row key combinations for
all output fields for the specified MOIP or ASI.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax for getting MOIP status output GET "https://192.168.0.1/ws/v2/status/output/moip/collision",

parameters GET "https://192.168.0.1/ws/v2/status/output/moip1/collision", or
GET "https://192.168.0.1/ws/v2/status/output/moip2/collision"

Syntax for getting ASI status output GET "https://192.168.0.1/ws/v2/status/output/asi/collision",

parameters GET "https://192.168.0.1/ws/v2/status/output/asi1/collision", or
GET "https://192.168.0.1/ws/v2/status/output/asi2/collision"

Table 60: URI <level_1> URI Parameters (extension to the Command URL separated by /)

URI Level 1 Parameter Description

asi/asi1/as2 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.

moip/moip1/moip2 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 supported values are moip1 for IP output 1 and
moip2 for IP output 2/

Table 61: URI <level_2> URI Parameters (extension to the Command URL separated by /)

URI Level 2 Parameter Description

collision DPM Active collision information.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
78
API Definitions
Output Status Command

Table 62: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Table 63: Output Field Descriptions

URI Level 2 Parameter Description

idx (Key) Index
Type: Integer
Values: 0 …65535

type 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"

peidx1 PE index-1
Type: Integer
Values: 1..32

pmtrow1 PMT Row-1

Type: Integer
Values: 1 … 65

peidx2 PE index-2
Type: Integer
Values: 1..32

pmtrow2 PMT Row-2

Type: Integer
Values: 1 … 65

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
79
 API Definitions
Output Status Command

URI Level 2 Parameter Description

value Conflict Value
Type: Integer
Values: 0 … 65535

status Indicate the API output status

Type: String
Values: text to indicate the output status
Note DPM active collision is dynamic data. If
there is no collision information in UIC
table, the "status" field will indicate the
reason.

ASI example on 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/collision&js=1"
Expected output (values are for example purposes only):
{
"output": {
"asi": {
"collision": {
"status": "No Record in Dynamic Table"
}
}
}
}
MOIP example on single-stream 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"
Expected output (values are for example purposes only):
{
"output": {
"asi1": {
"collision": {
"status": "No Record in Dynamic Table"
}
}
}
}
MOIP Example on NTC multi-stream unit (for which MOIP2 output was configured):
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/output/moip2/collision&js=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
80
 API Definitions
Video Decode Status Command

Expected output (values are for example purposes only):

{
"output": {
"moip2": {
"collision": {
"status": "No Record in Dynamic Table"
}
}
}
}

Video Decode Status Command

Table 64: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/video

Command Information This command can be used to read all video decode status.
Note Partial response is not supported. This command returns
the status of all video decode output fields.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/video"

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 &):

URI Parameter Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
81
 API Definitions
Video Decode Status Command

Table 66: Output Field Descriptions

Output Field Description

stream Input Stream Format
Type: String
Values:
"SD480i/2997", "SD480p/2997", "SD480i/3000", "SD576i/2500",
"SD576p/2500", "HD720p/5000", "HD720p/5994", "HD720p/6000",
"HD1080i/2500", "HD1080i/2997", "HD1080i/3000", "Unsupported"

pvoformat PV Output Format

Type: String
Values: "HD1080i", "HD720p", "SD", "HD1080p"

sdoformat SD Video Output Format

Type: String
Values: "PAL-B/G/I/D", "PAL-M", "PAL-N (AR)", "NTSC"

bitrate Bitrate in bps

Type : Integer
Values: 0.. 4294967295

pulldown32 3:2 pulldown

Type: String
Values: "Yes", "No", or "Recent"

frmpersec Frames per second

Type : Integer
Values: 0.. 4294967295

syncmode Synch mode

Type: String
Values: "Auto", "Manual"

encoding Encoding standard

Type: String
Values: "MPEG1", "MPEG2", "H264", "VC1", "MPEG_P2", or
"Unknown"

Example:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/video"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
82
 API Definitions
Audio Decode Status Command

Audio Decode Status Command

Table 67: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/audio

Command Information This command is used to read all the audio decode statuses.
Note Partial response is not supported. This command returns
the status of all audio decode output fields.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/audio"

URI Parameters (extension to the Command URL separated by /): N/A

Table 68: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

device Audio Device Instance
Type: Integer
Value: 1 .. 4

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

Table 69: Output Field Descriptions

Output Field Description

mode Audio Mode
Type: String
Value: "Stereo", "Mixed", "L-MONO", "R-MONO"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
83
 API Definitions
Audio Decode Status Command

Output Field Description

bitrate Bitrate in bps
Type : Integer
Values: 0.. 4294967295

bufferlvl Buffer level

Type : Integer
Values: 0.. 4294967295

sfr Sample rate of input audio stream

Type: UINT32
Value: 0..0xFFFFFFFF

ddpmode Dolby Digital Mode

Type: String
Value: "Trans", "Pass"

dualmono Audio Dualmono Mode

Type: String
Value: "OFF", "DUAL-MONO"

lang Language Value.

Type: String
Value: Any valid 3 character language code, for example: "eng"

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>
<mode>None</mode>
<bitrate>0</bitrate>
<bufferlvl>0</bufferlvl>
<sfr>0.0</sfr>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
84
 API Definitions
Audio STC302 Decode Status Command

<pid>
</pid>
<lang></lang>
<ddpmode>OFF</ddpmode>
<dualmono>OFF</dualmono>
</audio>
</decode>
Get Audio Device 1 status in JSON format:
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/decode/audio?device=1&js=1"
Expected output (values are for example purposes only):
{
"decode": {
"audio": {
"device": "1",
"mode": "None",
"bitrate": "0",
"bufferlvl": "0",
"sfr": "0.0",
"pid": "",
"lang": "",
"ddpmode": "OFF",
"dualmono": "OFF"
}
}
}

Audio STC302 Decode Status Command

Table 70: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/audio/st302

Command Information This command can be used to read all ST302 audio decode status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/aud_st302"

URI Parameters (extension to the Command URL separated by /): N/A

Table 71: Output Field Descriptions

Output Field Description

device ST302 Device Instance
Type: Integer
Value: 1

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
85
 API Definitions
Closed Caption (CC) Decode Status Command

Output Field Description

streamformat ST302 stream format
Type: String
Value: "Unknown", "Dolby-E"

numstreams Number of ST302 Streams (each consisting of 2 channels)

Type : String
Values: "0", "1", "2", "3", "4"

packetsize ST302 Stream Packet Size

Type : String
Values: "Unknown", "1920", "1620/1621"

dolbyconfig Dolby-E Program COnfiguration

Type: String
Value: one of the following options:
"Unknown", "5.1 + 2", "5.1 + 2x1", "4 + 4", "4 + 2x2", "4 + 2 + 2x1",
"4 + 4x1", "4x2", "3x2 + 2x1", "2x2 + 4x1", "2 + 6x1", "8x1", "5.1", "4
+ 2", "4 + 2x1", "3x2", "2x2 + 2x1", "2 + 4x1", "6x1”, “4”, "2 + 2", "2
+ 2x1", "4x1", "7.1", "7.1 Screen", "PCM Bypass".

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 Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/cc

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
86
API Definitions
Closed Caption (CC) Decode Status Command

Command Detail Description

Command Information This command can be used to read all Closed Caption decode status.
Note Partial response is not supported. This command returns
the status of all closed caption decode output fields.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/cc"

URI Parameters (extension to the Command URL separated by /): N/A

Table 73: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Parameter Description

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

Table 74: Output Field Descriptions

Output Field Description

ccoutact Actual Closed Caption Output
Type: String
Value: "SA Custom", "EIA 708", "Type 3", "Type 4
SA", "Type 4 ATSC", "Reserved", "DVS 157",

Input example (request default XML format:

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/cc"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<decode>
<cc>
<ccoutact>Auto</ccoutact>
</cc>
</decode>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
87
 API Definitions
VBI Decode Status Command

Input example (request JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/cc?js=1"
Expected output (values are for example purposes only):
{
"decode": {
"cc": {
"ccoutact": "Auto"
}
}
}

VBI Decode Status Command

Table 75: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/vbi

Command Information This command is used to read all VBI decode statuses.
Note Partial response is not supported. This command returns
the status of all closed caption decode output fields.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/vbi"

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 &)

URI Parameter Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
88
 API Definitions
SDI Decode Status Command

Table 77: Output Field Descriptions

Output Field Description

vitcstatus VIT Status
Type: String
Values: "LTC", "VITC", "BOTH", "UNDEFINED"

Input Example (request default XML format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/vbi"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<decode>
<vbi>
<vitcstatus>VITC</vitcstatus>
</vbi>
</decode>
Input Example (request JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/vbi?js=1"
Expected output (values are for example purposes only):
{
"decode": {
"vbi": {
"vitcstatus": "VITC"
}
}
}

SDI Decode Status Command

Table 78: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/<level_1_parm>

Command Information This command is used to read all SDI global or SDI services decode
status.
Note Partial response is not supported. This command returns
the status of all decode output fields for the specified
level_1_parm SDI type.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/sdigglb" or

GET "https://192.168.0.1/ws/v2/status/decode/sdisvc"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
89
 API Definitions
SDI Decode Status Command

Table 79: URI Parameters (extension to the Command URL separated by /):

URI Parameter Description

sdiglb Return SDI Global status

sdisvc Return SDI Services status

Table 80: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

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

Table 81: Output Field Descriptions

Output Field Description

interlaced Indicates if video is interlaced
Type: String
Values: "Yes" or "No"

framessec Video frames per second

Type: Integer
Values: 0 ... 4294967295

lines Lines per video frame

Type : Integer
Values: 0 ... 4294967295

wordsline VANC words per line

Type : Integer
Values: 0 ... 4294967295

firstline VANC area: first line

Type : Integer
Values: 0 ... 4294967295

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
90
API Definitions
SDI Decode Status Command

Output Field Description

lastline VANC area: last line
Type: Integer
Values: 0 ... 4294967295

switchline VANC area: switch line

Type: Integer
Values: 0 ... 4294967295

multiline Loop of service types

Type: String
Values: "Yes" or "No"

Table 82: Output Field Descriptions when requesting SDI Services Status (sdisvc)

Output Field Description

serviceid VANC Service identifier
"EIA-708", "AFD", "DPI", "SMPTE-2031", "SDP-OP47", or
"MULTI-OP47"

active Service is being output

Type: String
Values: "Yes" or "No"

adjline Line number where VANC service is expected

Type: Integer
Values: 0 ... 4294967295

topline Line number where VANC service is located (in top field or
frame)
Type: Integer
Values: 0 ... 4294967295

bottomline Line number where VANC service is located (in bottom field)
Type: Integer
Values: 0 ... 4294967295

maxlines Maximum number of lines used by VANC service

Type: Integer
Values: 0 ... 4294967295

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
91
 API Definitions
SDI Decode Status Command

Output Field Description

avgdata Average size of VANC service data per frame
Type: Integer
Values: 0 ... 4294967295

avgtranpkt Average number of transmitted VANC packets per frame

Type: Integer
Values: 0 ... 4294967295

avgdroppkt Average number of dropped VANC packets per frame

Type: Integer
Values: 0 ... 4294967295

Request SDI Global status (with result in JSON format) example:

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/decode/sdiglb"
Expected output (values are for example 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",
"maxlines": "0",
"avgdata": "0",
"avgtranpkt": "0",
"avgdroppkt": "0"
},
{
"serviceid": "AFD",
"active": "No",
"adjline": "2",
"topline": "0",
"bottomline": "0",
"maxlines": "0",
"avgdata": "0",
"avgtranpkt": "0",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
92
 API Definitions
HDMI Decode Status Command

"avgdroppkt": "0"
},
{
"serviceid": "DPI",
"active": "No",
"adjline": "3",
"topline": "0",
"bottomline": "0",
"maxlines": "0",
"avgdata": "0",
"avgtranpkt": "0",
"avgdroppkt": "0"
},
{
"serviceid": "SMPTE-2031",
"active": "No",
"adjline": "4",
"topline": "0",
"bottomline": "0",
"maxlines": "0",
"avgdata": "0",
"avgtranpkt": "0",
"avgdroppkt": "0"
},
{
"serviceid": "SDP-OP47",
"active": "No",
"adjline": "5",
"topline": "0",
"bottomline": "0",
"maxlines": "0",
"avgdata": "0",
"avgtranpkt": "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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/decode/hdmi

Command Information This command is used to read all or single device HDMI decode
status.

HTTP Method GET

Access Type Read

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
93
 API Definitions
HDMI Decode Status Command

Command Detail Description

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/decode/hdmi" or

GET "https://192.168.0.1/ws/v2/status/decode/hdmi?hdmiindex=1"

URI Parameters (extension to the Command URL separated by /): N/A

Table 84: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Parameter Description

hdmiindex HDMI device (instance) number
Type: integer
Values: 1 … 2

js 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

Table 85: Output Field Description

Output Field Description

hdmiindex HDMI device (instance) number
Type: integer
Values: 1 … 2

connected HDMI output connected to monitor

Type: String
Values: "Yes", "No"

powered HDMI device powered

Type : String
Values: "Yes", "No"

monitorname Name of monitor name connected to HDMI output

Type : String
Values: Text, up to 40 characters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
94
API Definitions
HDMI Decode Status Command

Output Field Description

colorspace HDMI Color Space
Type: String
Value: "Unknown", "YCbCr420", "YCbCr444", "YCbCr422",
"RGB"

colordepth HDMI Color Depth

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

colorrange HDMI Color Range

Type: String
Value: "Auto", "Full", "Limited"

matrixcoeff HDMI Matrix Coefficients

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

eotf HDMI EOTF (Electro-Optical Transfer Function)

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

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
Identity Status Command

}
}
Input example (request JSON format):
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/decode/hdmi?hdmiindex=1&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"
}
}
}

Identity Status Command

Table 86: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/identity

Command Information This command is used to read all identity details.

Note Partial response is not supported. This command
simultaneously returns the status of all identity details
output fields.
HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/identity"

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
96
API Definitions
Identity Status Command

Table 87: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Parameter Description

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

Table 88: Output Field Descriptions

Output Field Description

hostname Host name
Type: String
Value: Maximum of 64 characters

trackingid Tracking ID
Type: String
Value: Maximum of 13 characters

masterua Master user address

Type: String
Value: Maximum of 15 characters

CtlMacAddr Ethernet control port MAC address

Type: String
Value: Maximum of 18 characters (format “00:00:00:00:00:00”)

hwoptions

mpoipout MPEG Over IP Output Supported

Type: String
Value: "Yes" (if "No" then element will not be output)

mpoipin MPEG Over IP Input Supported

Type: String
Value: "Yes" (if "No" then element will not be output)
moipfec MPEG Over IP FEC Supported
Type: String
Value: "Yes" (if "No" then element will not be output)

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
97
 API Definitions
Identity Status Command

Output Field Description

sdi Serial Digital Interface Supported
Type: String
Value: "Yes" (if "No" then element will not be output)
Licenses
Note The field returned is a maximum of 8 characters, regardless of whether or not it represents a numeric
value.
HD Transcode License Count Number of HD transcode licenses
Type: String
Value: 1..N (if 0 then element will not be output)

SD Transcode License Count Number of SD transcode licenses

Type: String
Value: 0..N (if 0 then element will not be output)

HEVC Transcode License Count Number of HEVC transcode licenses

Type: String
Value: 1..N (if 0 then element will not be output)

Tuner License Count Number of tuner licenses

Type: String
Value: 1..N (if 0 then element will not be output)

Decrypt License Licensed for decryption

Type: String
Value: "Yes" (if "No" then element will not be output)

DVB_S2 License Licensed for DVB S2

Type: String
Value: "Yes" (if "No" then element will not be output)

Tuner APSK License Licensed for tuner APSK

Type: String
Value: "Yes" (if "No" then element will not be output)

AVC Decode License Licensed for AVC decode

Type: String
Value: "Yes" (if "No" then element will not be output)

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
98
API Definitions
Identity Status Command

Output Field Description

HEVC Decode License Licensed for HEVC decode
Type: String
Value: "Yes" (if "No" then element will not be output)

HD Output License Licensed for HD output

Type: String
Value: "Yes" (if "No" then element will not be output)

Full HD Output License Licensed for full HD output

Type: String
Value: "Yes" (if "No" then element will not be output)

UHD Output License Licensed for UHD output

Type: String
Value: “Yes” (if “No” then element will not be output)

AUD3_4 License Licensed for audio 3 and 4 output

Type: String
Value: “Yes” (if “No” then element will not be output)

licensefile
These elements are the same data as "licenses" 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.
Note The field returned is maximum of 8 characters, regardless of whether or not it represents a numeric
value
HD_Transcode Number of HD transcode licenses
Type: String
Value: 1..N (if 0 then element will not be output)

SD_Transcode Number of SD transcode licenses

Type: String
Value: 1..N (if 0 then element will not be output)

HEVC_Xcode Number of HEVC transcode licenses

Type: String
Value: 1..N (if 0 then element will not be output)

Tuner Number of tuner licenses

Type: String
Value: 1..N (if 0 then element will not be output)

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
99
 API Definitions
Identity Status Command

Output Field Description

DECRYPT Licensed for decryption
Type: String
Value: "1" (if "0" then element will not be output)

DVB_S2 Licensed for DVB S2

Type: String
Value: "1" (if "0" then element will not be output)

Tuner_APSK Licensed for tuner APSK

Type: String
Value: "1" (if "0" then element will not be output)

AVC_Decode Licensed for AVC decode

Type: String
Value: "1" (if "0" then element will not be output)

HEVC_Decode Licensed for HEVC decode

Type: String
Value: "1" (if "0" then element will not be output)

HD_Output Licensed for HD output

Type: String
Value: "1" (if "0" then element will not be output)

Full_HD_Output Licensed for full HD output

Type: String
Value: "1" (if "0" then element will not be output)

UHD_Output Licensed for UHD output

Type: String
Value: "1" (if "0" then element will not be output)

AUD3_4 Licensed for audio 3 and 4 output

Type: String
Value: "1" (if "0" then element will not be output)

Input example (request default XML format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/identity"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
100
API Definitions
Identity Status Command

Expected output (values are for example purposes only):

<?xml version="1.0" encoding="ISO-8859-1" ?>
<ident><hostname>User-cfg-name</host
name><trackingid>456JK123YX</trackingid><masterua>123-123-4567-1</masterua><ctlm
acaddr>38:C8:5D:FF:AF:E3</ctlmacaddr><hwoptions><mpoipout>Yes</mpoipout><mpoipin
>Yes</mpoipin><moipfec>Yes</moipfec><sdi>Yes</sdi></hwoptions><licenses><feature
>Tuner License Count</feature><enabled>4</enabled><feature>DVB_S2 License</featu
re><enabled>Yes</enabled><feature>AVC Decode License</feature><enabled>Yes</enab
led><feature>HEVC Decode License</feature><enabled>Yes</enabled><feature>HD Outp
ut License</feature><enabled>Yes</enabled><feature>Full HD Output License</featu
re><enabled>Yes</enabled><feature>AUD3_4 License</feature><enabled>Yes</enabled>
</licenses><licensefile><feature>Tuner</feature><enabled>3</enabled><feature>DVB
_S2</feature><enabled>1</enabled><feature>AVC_Decode</feature><enabled>1</enable
d><feature>HEVC_Decode</feature><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",
"ctlmacaddr": "38:C8:5D:FF:AF:E3",
"hwoptions": {
"mpoipout": "Yes",
"mpoipin": "Yes",
"moipfec": "Yes",
"sdi": "Yes"
},
"licenses": {
"feature": "Tuner License Count",
"enabled": "4",
"feature": "DVB_S2 License",
"enabled": "Yes",
"feature": "AVC Decode License",
"enabled": "Yes",
"feature": "HEVC Decode License",
"enabled": "Yes",
"feature": "HD Output License",
"enabled": "Yes",
"feature": "Full HD Output License",
"enabled": "Yes",
"feature": "AUD3_4 License",
"enabled": "Yes"
},
"licensefile": {
"feature": "Tuner",
"enabled": "3",
"feature": "DVB_S2",
"enabled": "1",
"feature": "AVC_Decode",
"enabled": "1",
"feature": "HEVC_Decode",
"enabled": "1",
"feature": "HD_Output",
"enabled": "1",
"feature": "Full_HD_Output",
"enabled": "1",
"feature": "AUD3_4",
"enabled": "1"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
101
 API Definitions
Device Status Command

Device Status Command

Table 89: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/device
https://192.168.0.1/ws/v2/status/device/<level_1_extension>
https://192.168.0.1/ws/v2/status/device/about/clear

Command Information This command is used to read either all or a specific category of device
details. It may also be used to clear.

HTTP Methods GET, POST (see Syntax row)

Access Type Read

Access Level User, Admin

Syntax One of the following:

GET "https://192.168.0.1/ws/v2/status/device"
GET "https://192.168.0.1/ws/v2/status/device/ecc"
GET "https://192.168.0.1/ws/v2/status/device/ethernet"
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

Table 90: URI <level_1_extension> Parameters (extension to the Command URL separated by /)

URI Parameter Description

None Reads and returns current value of all device categories and
related items.

ecc Reads and returns current value of ECC specific device items.

eth Reads and returns current value of ethernet specific device items.

power Reads and returns current value of power status device items
for all populated card slots.

about Reads and returns current value of about specific (uncategorized)

device items.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
102
API Definitions
Device Status Command

Table 91: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

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

See descriptions and other arguments for each variant of this command in the following sections.

About Status Command

Table 92: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/device/about

Command Information This command reads and returns uncategorized device items or zeros
out the liferstclr counter.

HTTP Methods GET, POST (see Syntax row)

Access Type Read, Write (for POST operation only)

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/device/about", or

POST "https://192.168.0.1/ws/v2/status/device/about/clear"

Table 93: URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

none Read all (when no Arguments) uncategorized device items or
specific item(s) (when Argument(s) are specified)

clear Clears the life reset counter (liferstclr) in the relevant device/about
output field.
Requires the POST HTTP Method and only valid when specified
after …/ws/v2/status/device/about.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
103
 API Definitions
Device Status Command

Table 94: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

See the Output Field Descriptions table Specifying any or combination of the output field
values (separated by &) will filter the output to only
return those fields.
js 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.

Table 95: Output Field Descriptions

Output Field Description

modelnum Model number
Type: String
Value: Maximum of 50 characters

modelname Model name

Type: String
Value: Maximum of 50 characters

catalognum Catalogue number

Type: String
Value: Maximum of 50 characters

boardid Board ID
Type: String
Value: Maximum of 50 characters

boardrev Board revision

Type: String
Value: Maximum of 50 characters

fpgatype FPGA type

Type: String
Value: Maximum of 50 characters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
104
API Definitions
Device Status Command

Output Field Description

fpgaid FPGA ID
Type: String
Value: Maximum of 20 characters

serialnum Unit serial number

Type: String
Value: Maximum of 50 characters

petrans Maximum number of program entries simultaneously transcoded

Type: Integer
Value: 0..N

ethports Number of Ethernet ports

Type: Integer
Value: 0..N

copyright Copyright statement

Type: String
Value: Maximum of 100 characters

proddate Production date and time

Type : String
Values: string format "yyyy/mm/dd hh:mm:ss"

pwrupdate Last power on date and time

Type : String
Values: string format "yyyy/mm/dd hh:mm:ss"

lifepower Lifetime number of hours powered on

Type : Integer
Values: 0..N

lifereset Lifetime number of resets

Type : Integer
Values: 0..N

liferstclr Clearable count of number of resets

Type : Integer
Values: 0..N

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
105
 API Definitions
Device Status Command

Output Field Description

hoursup Number of hours powered since power-on/reset
Type : Integer
Values: 0..N

lastrsttxt Reason for last reset (for example, power on)

Type : String
Values: Maximum of 128 characters

about1,2, 3, 4, 5, 6, or 7 Line # of 7 of "about" text (legal jargon)

Type : String
Values: Maximum of 256 characters

Input example (request JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/about?js=1"
Expected output (values are for example purposes only):
{
"device": {
"about": {
"modelnum": "D9800",
"modelname": "Network Transport Receiver",
"catalognum": "D9800-SS-MPEGOIP",
"boardid": "NTC",
"boardrev": "01",
"fpgatype": "1.00",
"fpgaid": "Wildcard FPGA ID",
"serialnum": "BLAH1234",
"petrans": "0",
"ethports": "3",
"copyright": "2016-2017 Cisco Systems Inc. All rights reserved",
"proddate": "2016/08/30 18:17:36",
"pwrupdate": "2017/03/20 22:01:12",
"lifepower": "5535",
"lifereset": "689",
"liferstclr": "0",
"hoursup": "167",
"lastrsttxt": "DL Shutdown Request",
"about1": "This Cisco product (D9800 Network Transport ReceiverUnavailab",
"about2": ") contains software licensed under the following licenses:",
"about3": "<br>\"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>\"GNU Lesser General Public License, version 2.1\" provided with
ABSOLUTELY NO WARRANTY under the terms of \"GNU Lesser General Public License, version
2.1\", available here:http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html",
"about6": "<br>\"GNU Library General Public License, version 2\" provided with
ABOSOLUTELY NO WARRANTY under the terms of \"GNU Library General Public License, version
2\", available here:http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html",
"about7": "<br>You can see the complete 3rd party open source licensing
information at http://www.cisco.com/go/receivers_licensing. If you have any questions or
problems accessing the link, please contact:external-opensource-requests@cisco.com."
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
106
API Definitions
Device Status Command

Input example (request JSON format, filtered output):

curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/device/about?pwrupdate&lastrsttxt&js=1"
Expected output (values are for example purposes only):
{
"device": {
"about": {
"lastrsttxt": "DL Shutdown Request",
"pwrupdate": "2017/03/20 22:01:12"
}
}
}
Input (request XML format, clear the liferstclr counter):
curl -k -H "X-SESSION-ID: $token" –X POST
"https://192.168.0.1/ws/v2/status/device/about/clear"
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>

ECC Status Command

Table 96: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/device/ecc

Command Information Return status of ecc (environmental characteristics and control) items.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/device/ecc"

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
107
 API Definitions
Device Status Command

Table 97: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

slot (Mandatory when row is specified) This is a key field for filtering output fields to a specified slot.
When used with ecc URI extension, this argument also requires
specifying the table row key. The user or client software must
have previous knowledge of all of the ecc row indices for a specific
software and hardware configuration. Filtering output for ecc
related device data may be useful as part of an overall automated
client command caching strategy (after retrieving the entire table
at least once so that the row indices are already known).
Type: Integer
Values: 0 ...

row (Mandatory when slot is specified) This is a key field for filtering output fields to a specified row.
See description under slot.
Type: Integer
Values: 0 ...

js 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

Table 98: Output Field Descriptions

Output Field Description

slot Chassis slot number
Type: Integer
Value: 1 to number of slots in chassis

row Row number

Type: Integer
Value: 1 to number of rows on unit

card Chassis card acronym

Type: String
Value: for example, "NTC"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
108
API Definitions
Device Status Command

Output Field Description

displayItemName Specific ecc item
Type: String
Value: for example, "+12.0V” to read 12 volt supply current
reading

type Category of ecc item

Type: String
Value: "Temperature", "Voltage", "Fan Status/Speed" or “N/A”

value Actual value of given item

Type: String
Value: for example, "+12.23V" (current +12.0V supply
reading)

cardslot Concatenation of card and slot fields

Type: String
Value: for example, "NDM1"

Input example (request default XML format, all ECC data):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/ecc"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<device><ecc><slot>0</slot><row>0</row><card>NBP</card><displayBoardName>System</displayBoardName>
<location>curr_in_temp</location><displayItemName>System
Intake</displayItemName><type>Temperature</type>
<value>+26
C</value><cardslot></cardslot><displayOrderFlag>0</displayOrderFlag></ecc><ecc><slot>0</slot><row>1</row>
<card>NBP</card><displayBoardName>System</displayBoardName><location>hist_max_in_temp</location>
<displayItemName>Ambient Peak Temp</displayItemName><type>Temperature</type><value>+37
C</value><cardslot></cardslot>
<displayOrderFlag>0</displayOrderFlag></ecc><ecc><slot>0</slot><row>2</row><card>NBP</card>
<displayBoardName>System</displayBoardName><location>hist_avg_in_temp</location>
<displayItemName>Ambient Temp Average</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</row><card>NBP</card>
<displayBoardName>System</displayBoardName><location>left fan</location><displayItemName>Left
Fan</displayItemName>
<type>Fan Status/Speed</type><value>11045 RPM</value><cardslot>NBP0</cardslot>
<displayOrderFlag>253</displayOrderFlag></ecc><ecc><slot>0</slot><row>5</row><card>NBP</card>
<displayBoardName>System</displayBoardName><location>right fan</location>
<displayItemName>Right Fan</displayItemName><type>Fan Status/Speed</type><value>11430
RPM</value>
<cardslot>NBP0</cardslot><displayOrderFlag>251</displayOrderFlag></ecc><ecc><slot>0</slot><row>6</row>
<card>NBP</card><displayBoardName>System</displayBoardName><location>max temp</location>
<displayItemName>Current Maximum Temp</displayItemName><type>Temperature</type><value>+71.4
C</value>
<cardslot>NBP0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>7</row>
<card>NTC</card><displayBoardName>Controller</displayBoardName><location>FPGA +1.0V</location>
<displayItemName>FPGA +1.0V</displayItemName><type>Voltage</type><value>+0.97 V</value>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
109
 API Definitions
Device Status Command

<cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>8</row>
<card>NTC</card><displayBoardName>Controller</displayBoardName><location>FPGA +1.8V</location>
<displayItemName>FPGA +1.8V</displayItemName><type>Voltage</type><value>+1.81
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>9</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>FPGA
temp</location><displayItemName>FPGA temp</displayItemName>
<type>Temperature</type><value>+71.9
C</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc>
<ecc><slot>0</slot><row>10</row><card>NTC</card><displayBoardName>Controller</displayBoardName><location>+12.0V</location>
<displayItemName>+12.0V</displayItemName><type>Voltage</type><value>+11.99
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>11</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>+3.3V</location><displayItemName>+3.3V</displayItemName>
<type>Voltage</type><value>+3.32
V</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc>
<slot>0</slot><row>12</row><card>NTC</card><displayBoardName>Controller</displayBoardName><location>+2.5V</location>
<displayItemName>+2.5V</displayItemName><type>Voltage</type><value>+2.50
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>13</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>+1.05V</location><displayItemName>+1.05V</displayItemName>
<type>Voltage</type><value>+1.05
V</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot>
<row>14</row><card>NTC</card><displayBoardName>Controller</displayBoardName><location>+1.5V</location>
<displayItemName>+1.5V</displayItemName><type>Voltage</type><value>+1.51
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>15</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>+0.9V</location><displayItemName>+0.9V</displayItemName>
<type>Voltage</type><value>+0.90
V</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc>
<ecc><slot>0</slot><row>16</row><card>NTC</card><displayBoardName>Controller</displayBoardName>
<location>+3.3V LDO</location><displayItemName>+3.3V
LDO</displayItemName><type>Voltage</type><value>+3.31 V</value>
<cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>17</row>
<card>NTC</card><displayBoardName>Controller</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>1</displayOrderFlag></ecc>
<ecc><slot>0</slot><row>19</row><card>NTC</card><displayBoardName>Controller</displayBoardName><location>+0.75V</location>
<displayItemName>+0.75V</displayItemName><type>Voltage</type><value>+0.76
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>20</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>+1.8V</location><displayItemName>+1.8V</displayItemName>
<type>Voltage</type><value>+1.81
V</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc>
<ecc><slot>0</slot><row>21</row><card>NTC</card><displayBoardName>Controller</displayBoardName><location>+1.2V</location>
<displayItemName>+1.2V</displayItemName><type>Voltage</type><value>+1.16
V</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>22</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>exhaust temp</location>
<displayItemName>Rear Temp</displayItemName><type>Temperature</type><value>+41.2 C</value>
<cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>23</row>
<card>NTC</card><displayBoardName>Controller</displayBoardName><location>intake
temp</location>
<displayItemName>Front Temp</displayItemName><type>Temperature</type><value>+26.6
C</value><cardslot>NTC0</cardslot>
<displayOrderFlag>1</displayOrderFlag></ecc><ecc><slot>0</slot><row>24</row><card>NTC</card>
<displayBoardName>Controller</displayBoardName><location>CPU
temp</location><displayItemName>CPU temp</displayItemName>
<type>Temperature</type><value>+42.2
C</value><cardslot>NTC0</cardslot><displayOrderFlag>1</displayOrderFlag></ecc>
<ecc><slot>1</slot><row>0</row><card>NFE</card><displayBoardName>Tuner</displayBoardName><location>FPGA
+1.0V</location>
<displayItemName>FPGA +1.0V</displayItemName><type>Voltage</type><value>+0.99
V</value><cardslot>NFE1</cardslot>
<displayOrderFlag>2</displayOrderFlag></ecc><ecc><slot>1</slot><row>1</row><card>NFE</card>
<displayBoardName>Tuner</displayBoardName><location>FPGA +1.8V</location><displayItemName>FPGA
+1.8V</displayItemName>
<type>Voltage</type><value>+1.79
V</value><cardslot>NFE1</cardslot><displayOrderFlag>2</displayOrderFlag></ecc>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
110
API Definitions
Device Status Command

<ecc><slot>1</slot><row>2</row><card>NFE</card><displayBoardName>Tuner</displayBoardName><location>FPGA
temp</location>
<displayItemName>FPGA temp</displayItemName><type>Temperature</type><value>+47.2
C</value><cardslot>NFE1</cardslot>
<displayOrderFlag>2</displayOrderFlag></ecc><ecc><slot>2</slot><row>0</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>FPGA
+1.0V</location><displayItemName>FPGA +1.0V</displayItemName>
<type>Voltage</type><value>+0.99
V</value><cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc><ecc>
<slot>2</slot><row>1</row><card>NDM</card><displayBoardName>Decoder</displayBoardName><location>FPGA
+1.8V</location>
<displayItemName>FPGA +1.8V</displayItemName><type>Voltage</type><value>+1.79
V</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>2</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>FPGA temp</location>
<displayItemName>FPGA temp</displayItemName><type>Temperature</type><value>+46.8
C</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>3</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>+1.0V
CPU</location><displayItemName>+1.0V CPU</displayItemName>
<type>Voltage</type><value>+0.94
V</value><cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc>
<ecc><slot>2</slot><row>4</row><card>NDM</card><displayBoardName>Decoder</displayBoardName><location>+3.3V</location>
<displayItemName>+3.3V</displayItemName><type>Voltage</type><value>+3.32
V</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>5</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>+2.5V</location>
<displayItemName>+2.5V</displayItemName><type>Voltage</type><value>+2.51
V</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>6</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>+1.8V</location><displayItemName>+1.8V</displayItemName>
<type>Voltage</type><value>+1.81
V</value><cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc>
<ecc><slot>2</slot><row>7</row><card>NDM</card><displayBoardName>Decoder</displayBoardName><location>+1.5V</location>
<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>9</row><card>NDM</card><displayBoardName>Decoder</displayBoardName>
<location>+3.3V LDO</location><displayItemName>+3.3V
LDO</displayItemName><type>Voltage</type><value>+3.32 V</value>
<cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>10</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>+1.0V</location>
<displayItemName>+1.0V</displayItemName><type>Voltage</type><value>+0.99
V</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>11</row><card>NDM</card>
<displayBoardName>Decoder</displayBoardName><location>+0.75V</location><displayItemName>+0.75V</displayItemName>
<type>Voltage</type><value>+0.77
V</value><cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc>
<ecc><slot>2</slot><row>12</row><card>NDM</card><displayBoardName>Decoder</displayBoardName>
<location>+12.0V</location><displayItemName>+12.0V</displayItemName><type>Voltage</type><value>+11.84
V</value>
<cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot><row>13</row>
<card>NDM</card><displayBoardName>Decoder</displayBoardName><location>intake temp</location>
<displayItemName>Front Temp</displayItemName><type>Temperature</type><value>+28.1 C</value>
<cardslot>NDM2</cardslot><displayOrderFlag>3</displayOrderFlag></ecc><ecc><slot>2</slot>
<row>14</row><card>NDM</card><displayBoardName>Decoder</displayBoardName><location>CPU
temp</location>
<displayItemName>CPU temp</displayItemName><type>Temperature</type><value>+43.3
C</value><cardslot>NDM2</cardslot>
<displayOrderFlag>3</displayOrderFlag></ecc></device>
Input example (request JSON format, all ECC data):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/ecc?js=1"
Input example (request JSON format, ECC data only for slot 0, row 12):
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/device/ecc?slot=0&row=12&js=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
111
 API Definitions
Device Status Command

Expected output (values are for example purposes only):

{
"device": {
"ecc": {
"slot": "0",
"row": "12",
"card": "NTC",
"displayBoardName": "Controller",
"location": "+2.5V",
"displayItemName": "+2.5V",
"type": "Voltage",
"value": "+2.50 V",
"cardslot": "NTC0",
"displayOrderFlag": "1"
}
}
}

Ethernet Status Command

Table 99: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/device/eth

Command Information Return status of Ethernet ports.

This command uses the ports referenced in Port Information, on page
8.
However, in this API, all of the port numbers have +1 added. As a result,
the Management Port is port1, DATA1 is port2, and DATA2 is port3.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/device/eth"

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 &)

URI Argument Description

port (optional) This is a key field for filtering output fields to a specified port.
Ethernet port number
Type: Integer
Value: NTC Basic: 1 NTC MOIP: 1-3 NTC MS: 1-5

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
112
API Definitions
Device Status Command

URI Argument Description

js (optional) 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

Table 101: Output Field Descriptions

Output Field Description

link Ethernet link status
Type: String
Value: "Link Up" or "Link Down"

speed Ethernet link speed

Type: String
Value: "10 Mbps", "100 Mbps", "1 Gbps", or "N/A"

duplex Ethernet link speed

Type: String
Value: "Half", "Full", or "N/A"

xover Ethernet MDI status (crossover)

Type: String
Value: "MDI", "MDIX", or "N/A"

Input example (request XML output format for data for all Ethernet ports):
curl -k -H "X-SESSION-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</duplex><xover>N/A</xover></eth></device>
Input example (get status of Ethernet port 1 in JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/eth?port=1&js=1"
Expected output (values are for example purposes only):
{
"device": {
"eth": {
"port": "1",
"link": "Link Up",
"speed": "1 Gbps",
"duplex": "Full",
"xover": "N/A"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
113
 API Definitions
Device Status Command

}
}
}

Power Status Command

Table 102: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/device/power

Command Information Return power status of all or individual slot(s) within the chassis.

HTTP Method GET

Access Type Read

Access Level Guest, User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/device/power"

URI Parameters (extension to the Command URL 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 &)

URI Argument Description

slot Slot number within the chassis
Type: Integer
Value: 0 to (number of slots in chassis – 1)

js (optional) Format output using JSON standard

Type: exist
Values: any value or empty (any of js=1, js, js=0, or js=9999 are
valid)
Omitting this argument formats the output by default in XML.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
114
API Definitions
Device Status Command

Table 104: Output Field Descriptions

Output Field Description

slot Slot number within the chassis
Type: Integer
Value: 0 to (number of slots in chassis – 1)

good Status of "power good" signal

Type: Boolean
Value: "Yes" or "No"

displayBoardName User Friendly Name of board in device slot

Type: String
Value: "Controller", "Tuner", "CI Option", or "Decoder" or
"TranscoderX", or "HEVC ProcX", where the X is replaced with
the unique instance number (counting, starting with 1) of the
particular board type that was detected by the software at target
initialization time.

status Status of slot check on power up

Type: Boolean
Value: "Ok" or "Fault"

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",
"displayBoardName": "Tuner",
"status": "Ok"
},
{
"slot": "2",
"good": "Yes",
"displayBoardName": "HEVC Proc1",
"status": "Ok"
},
{
"slot": "3",
"good": "Yes",
"displayBoardName": "Transcoder1",
"status": "Ok"
},

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
115
 API Definitions
Alarms and Warnings

{
"slot": "4",
"good": "Yes",
"displayBoardName": "Transcoder2",
"status": "Ok"
},
{
"slot": "5",
"good": "Yes",
"displayBoardName": "HEVC Proc2",
"status": "Ok"
},
{
"slot": "6",
"good": "Yes",
"displayBoardName": "CI option",
"status": "Ok"
}
]
}
}
Input example (Get status of slot power for slot 1 in JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/device/power?slot=1&j
Expected output (values are for example purposes only):
{
"device": {
"power": {
"slot": "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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/faults

Command Information Returns all faults status details information.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/faults"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
116
API Definitions
Alarms and Warnings

URI Parameters (extension to the Command URL separated by /): N/A

Table 106: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

js (optional) 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.

Input example (read back all faults info in JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/faults?js=1"
Expected output (values are for example purposes only):
{
"faults": {
"summary": {
"actalarms": "0",
"actwarns": "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": "FPGATemperature Warning",
"type": "Warning",
"details": "ecc_reset_fpga_temp_warn",
"setdatetim": "2017/03/03 23:06:27",
"rstdatetim": "2017/03/03 23:06:48",
"state": "Clear"
},
{
"name": "Signal Status ",
"type": "Alarm",
"details": "RF1 Signal is lost",
"setdatetim": "2017/03/21 22:25:11",
"rstdatetim": "",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
117
 API Definitions
Alarms and Warnings

"state": "Set"
},
]
}

Fault Actions Status Command

Table 107: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/faults/actions

Command Information Clears fault history, alarms, or warnings.

HTTP Method POST

Access Type Write

Access Level User, Admin

Syntax One of the following:

POST "https://192.168.0.1/ws/v2/status/faults/actions/clralarms"
POST "https://192.168.0.1/ws/v2/status/faults/actions/clrwarns"
POST "https://192.168.0.1/ws/v2/status/faults/actions/clrhistory"

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 &)

URI Argument Description

js (optional) 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.

Table 109: Output Field Descriptions

Output Field Description

clralarms Clear Alarm Faults

clrwarns Clear Warnings

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
118
API Definitions
Alarms and Warnings

Output Field Description

clrhistory Clear Fault History

Input example (Clear Alarm Faults):

curl -k -X POST -H "Accept: application/json" -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/faults/actions/clralarms"
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>
Input example (Clear Warnings):
curl -k -X POST -H "Accept: application/json" -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/status/faults/actions/clrwarns"
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>
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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/faults/summary

Command Information Returns all faults status summary information.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/faults"

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
119
 API Definitions
Alarms and Warnings

Table 111: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

js (optional) 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.

Table 112: Output Field Descriptions

Output Field Description

actalarms Number of active alarms
Type: Integer
Value: 0 ... 4294967295

actwarns Number of active warnings

Type: Integer
Value: 0 ... 4294967295

clrfaults Number of cleared faults

Type: Integer
Value: 0 ... 4294967295

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 in JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/summary?js=1"
Expected output (values are for example purposes only):
{
"faults": {
"summary": {
"actalarms": "1",
"actwarns": "3",
"clrfaults": "144"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
120
API Definitions
Alarms and Warnings

Faults Status Command

Table 113: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/faults/summary/status

Command Information Returns only faults status information.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/faults/status"

URI Parameters (extension to the Command URL separated by /): N/A

Table 114: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

js (optional) 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.

Table 115: Output Field Descriptions

Output Field Description

Type Fault Type
Type: String
Value: "Alarm", "Warning"

name Fault name

Type: String
Value: Maximum of 24 characters

details Fault description

Type: String
Value: Maximum of 64 characters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
121
 API Definitions
Alarms and Warnings

Output Field Description

setsince Date and time fault was triggered
Type : String
Values: string format "yyyy/mm/dd hh:mm:ss"

Input example (read back faults status in default XML format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/faults/status"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<faults>
<status>
<type>Warning</type>
<name>TDT warning </name>
<details>RF1 TDT is lost</details>
<setsince>2017/03/21 22:26:06</setsince>
</status>
<status>
<type>Warning</type><name>SDT warning </name>
<details>RF1 SDT is lost</details>
<setsince>2017/03/21 22:25:36</setsince>
</status>
<status><type>Warning</type>
<name>PMT warning </name>
<details>PE 1 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": "Warning",
"name": "TDT warning ",
"details": "RF1 TDT is lost",
"setsince": "2017/03/21 22:26:06"
},
{
"type": "Warning",
"name": "SDT warning ",
"details": "RF1 SDT is lost",
"setsince": "2017/03/21 22:25:36"
},
{
"type": "Warning",
"name": "PMT warning ",
"details": "PE 1 PMT is lost",
"setsince": "2017/03/21 22:25:36"
},
{
"type": "Warning",
"name": "PAT warning ",
"details": "RF1 PAT is lost",
"setsince": "2017/03/21 22:25:36"
},

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
122
API Definitions
Alarms and Warnings

{
"type": "Warning",
"name": "NIT warning ",
"details": "RF1 NIT is lost",
"setsince": "2017/03/21 22:25:36"
},
{
"type": "Warning",
"name": "CAT warning ",
"details": "RF1 CAT is lost",
"setsince": "2017/03/21 22:25:36"
}
]
}
}

Faults History Status Command

Table 116: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/faults/summary/history

Command Information Returns only faults history information.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/faults/history"

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 &)

URI Argument Description

js (optional) 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.

The following table lists the output fields:

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
123
 API Definitions
Alarms and Warnings

Table 118: Output Field Descriptions

Output Field Description

type Fault Type
Type: String
Values: "Alarm" or "Warning"

name Fault name

Type: String
Value: Maximum of 24 characters

details Fault description

Type: String
Value: Maximum of 64 characters

setdatetim Date and time fault was triggered

Type : String
Values: string format "yyyy/mm/dd hh:mm:ss"

rstdatetim Date and time fault was cleared

Type : String
Values: string format "yyyy/mm/dd hh:mm:ss"

state State of Fault

Type: String
Values: "Clear", "Set", "Clear By Reset"

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>Alarm</type>
<name>PE 1: Loss of Input</name>
<details>Loss of input detected</details>
<setdatetim>2010/11/12 23:53:41</ondatetim>
<rstdatetim> </rstdatetim>
</ record >
</ history >
</faults>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
124
 API Definitions
Disaster Recovery (D/R) Status Command

Input example (Read back faults history in JSON format):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/status/faults/history?js=1"
Expected output (values are for example purposes only):
{
"faults": {
"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": "System Startup ",
"type": "Alarm",
"details": "Auto reset after timeout",
"setdatetim": "2016/12/23 15:09:12",
"rstdatetim": "2016/12/23 15:09:13",
"state": "Clear"
},
{
"name": "System Startup ",
"type": "Alarm",
"details": "Auto reset after timeout",
"setdatetim": "2016/12/24 07: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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr
https://192.168.0.1/ws/v2/status/dr/<level_1_extension>

Command Information This command can be used to read either all or a specific category of
D/R details.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
125
 API Definitions
Disaster Recovery (D/R) Status Command

Command Detail Description

HTTP Method GET (See Syntax row)

Access Type Read

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/status/dr",

GET "https://192.168.0.1/ws/v2/status/dr/global",
GET "https://192.168.0.1/ws/v2/status/dr/tuning",
GET "https://192.168.0.1/ws/v2/status/dr/channels",
GET "https://192.168.0.1/ws/v2/status/dr/origtuning", or
GET "https://192.168.0.1/ws/v2/status/dr/origchans"

Table 120: URI <level_1_extension> Parameters (extension to the Command URL separated by /)

URI Argument Description

None Reads and returns current value of all D/R categories
and related items.

global Reads and returns current value of D/R global status.

tuning Reads and returns current value of D/R backup tuning.

channels Reads and returns current value of D/R backup

channels.

origtuning Reads and returns current value of D/R origin tuning.

origchans Reads and returns current value of D/R origin

channels.

Table 121: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

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

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
126
API Definitions
Disaster Recovery (D/R) Status Command

See descriptions and other Arguments for each variant of this command in the sections below.

Disaster Recover (D/R) Global Status Command

Table 122: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr/global

Command Information Get of D/R global status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax All D/R global status

GET "https://192.168.0.1/ws/v2/status/dr/global"

URI Parameters (extension to the Command URL separated by /): N/A

Table 123: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Argument Description

status DR Status
Type: String
Value: "D/R in progress", "No Disaster - D/R Ready", "D/R disabled
- Maintenance Mode", "NIT Retune Recovery in progress"

siglock DR Signal Lock Timeout Value

Type: Integer
Value: 5 … 255

siglost DR Signal Loss Timeout Vaule

Type: Integer
Value: 5 … 2160000

verify DR Verification Timeout Value

Type: Integer
Value: 10 … 255

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
127
 API Definitions
Disaster Recovery (D/R) Status Command

URI Argument Description

cfgsource DR Configuration Source
Type: String
Value: "None", "Uplink", "User"

GET Examples
Example 1: Retrieve the full D/R global status
The following example assumes that the user has successfully logged on to the unit, received the session ID,
and set the unit 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/global"
If successful, the return body will 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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr/tuning

Command Information Get of D/R backup tuning status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax All D/R backup tuning status.

GET "https://192.168.0.1/ws/v2/status/dr/tuning"
Single D/R backup tuning status, for example,
GET "https://192.168.0.1/ws/v2/status/dr/tuning?csirec=1"

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
128
API Definitions
Disaster Recovery (D/R) Status Command

Table 125: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Argument Description

csirec (Key) Record index of D/R backup tuning status.
Type: Integer
Values: 1 … 16

rowstatus D/R backup tuning status.

Type: String
Values: "Yes", "No"

input D/R backup tuning RF input.

Type: String
Values: "RF1", "RF2", "RF3", "RF4"

netid D/R backup tuning network id.

Type: Integer
Values: 0 ~ 65535

dnlkfreq D/R backup tuning Frequency [GHz].

Type: Float
Values: 0.0 … 15.0

symrate D/R backup tuning RF symbol rate.

Type: Float
Values: 1.0 ... 45.0

mod D/R backup tuning RF modulation system.

Type: String
Values: for example, "QPSK DVB-S"

fec D/R backup tuning FEC Mode.

Type: String
Values: "Auto”, "1/2", "2/3", "3/4", "5/6", "7/8", "8/9"

rolloff D/R backup tuning RF rolloff.

Type: String
Values: ".20", ".25", ".35", "Auto"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
129
 API Definitions
Disaster Recovery (D/R) Status Command

URI Argument Description

source DR CSI Source.
Type: String
Value: "None", "Uplink", "User"

ewflag DR West/East Flag.

Type: String
Values: "N/A", "East", "West"

orbpos DR Orbital Position [Deg].

Type: Float
Values: 0.0 ... 360.0

pol DR Orbital Polarization.

Type: String
Values: "Horiz", "Vert", "Circ_l", "Circ_r", "Auto"

GET Examples
Example 1: Retrieve D/R backup 1 tuning status
The following example assumes that the user has successfully logged on to the unit, received 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",
"netid": "1",
"orbpos": "0.0",
"pol": "Horiz",
"symrate": "30.0",
"rolloff": ".35",
"source": "User",
"rowstatus": "Yes"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
130
API Definitions
Disaster Recovery (D/R) Status Command

Disaster Recover (D/R) Backup Channels Status Command

Table 126: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr/channels

Command Information Get of D/R backup channel status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax All D/R backup channels status:

GET "https://192.168.0.1/ws/v2/status/dr/channels"
Single D/R backup channels setting, for example,
GET "https://192.168.0.1/ws/v2/status/dr/channels?peid=PE1&csirec=1&
bkpchan"

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 &):

URI Argument Description

peid (Key) D/R backup channel Program Entry ID
Type: String
Values: "PE1" … "PE16"

csirec (Key) Record index of D/R backup Transport

Type: Integer
Values: 1 … 16

bkpchan D/R backup channel number

Type: Integer
Values: 0 … 65535

rowstatus D/R backup channel status

Type: String
Values: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
131
 API Definitions
Disaster Recovery (D/R) Status Command

GET Examples
Example 1: Retrieve the PE1 channel and rowstatus of D/R backup 1
The following example assumes that the user has successfully logged on to the unit, received the session ID,
and set it to a variable token. In addition, it is assumed that the IP address of the unit is 192.168.0.1. You must
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/channels?peid=PE1&csirec=1&bkpchan&rowstatus"
If successful, the return body will look:
"dr": {
"channels": {
"peid": "PE1",
"csirec": "1",
"bkpchan": "201",
"rowstatus": "Yes"
}
}

Disaster Recovery (D/R) Origin Tuning Status Command

Table 128: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr/origtuning

Command Information Get of D/R origin tuning.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax All D/R origin tuning status:

GET "https://192.168.0.1/ws/v2/status/dr/origtuning"

URI Parameters (extension to the Command URL separated by /): N/A

Table 129: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Argument Description

input D/R origin tuning RF input
Type: String
Values: "RF1", "RF2", "RF3", "RF4"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
132
API Definitions
Disaster Recovery (D/R) Status Command

URI Argument Description

netid D/R origin tuning network id
Type: Integer
Values: 0 … 65535

dnlkfreq D/R origin tuning Frequency [GHz]

Type: Float
Values: 0.0..15.0

symrate D/R origin tuning RF symbol rate

Type: Float
Values: 1.0 ... 45.0

mod D/R origin tuning RF modulation system

Type: String
Values: for example, "QPSK DVB-S"

fec D/R origin tuning FEC Mode

Type: String
Values: "Auto”, "1/2", "2/3", "3/4", "5/6", "7/8", "8/9"

rolloff D/R origin tuning RF rolloff

Type: String
Values: ".20", ".25", ".35", "Auto"

ewflag DR West/East Flag

Type: String
Values: "N/A", "East", "West"

orbpos DR Orbital Position [Deg]

Type: Float
Values: 0.0 ... 360.0

pol DR Orbital Polarization

Type: String
Values: "Horiz", "Vert", "Circ_l", "Circ_r", "Auto"

GET Examples
Example 1: Retrieve D/R Orign tuning

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
133
 API Definitions
Disaster Recovery (D/R) Status Command

The following example assumes that the user has successfully logged on to 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/status/dr/origtuning"
If successful, the return body will be:
"dr": {
"origtuning": {
"fec": "AUTO",
"ewflag": "East",
"dnlkfreq": "12.03",
"input": "RF1",
"mod": "8PSK DVB-S2",
"netid": "1",
"orbpos": "120.0",
"pol": "Horiz",
"symrate": "30.0",
"rolloff": ".35"
}
}

Disaster Recover (D/R) Origin Channels Status Command

Table 130: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/status/dr/origchans

Command Information Allows get of D/R origin channel status.

HTTP Method GET

Access Type Read

Access Level User, Admin

Syntax 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"

URI Parameters (extension to the Command URL separated by /): N/A

Table 131: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Argument Description

peid (Key) D/R origin channel Program Entry ID
Type: String
Values: "PE1" … "PE16"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
134
 API Definitions
Configuration API

URI Argument Description

origchan D/R origin channel number
Type: Integer
Values: 0 … 65535

GET Examples
Example 1: Retrieve origin channel of PE1
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.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input

Command Information Allows inputs to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
135
 API Definitions
Input Configuration Command

Command Detail Description

POST Syntax Either (using body data from command line)
POST –-header "Content-type:application/xml" –d
"<input>some_XML_body_data</input>"
"https://192.168.0.1/ws/v2/service_cfg/input"
OR (using body data from XML file)
POST –-header "Content-type:application/xml" –d
@"C:/your_path/input.xml" "https://192.168.0.1/ws/v2/service_cfg/input"

Table 133: URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

default By default (no additional URL extension), all data is
returned in a GET, and any data may be set in a
POST.
See following command sections for API syntax that
extends this command URL and allows returning or
setting a categorized subset of the fields.

URI Query/Set Arguments (possible fields and values preceded by ? and separated by &): N/A
Input XML Field Descriptions:
The XML parameters are as described in each of the following input configuration API sections Arguments
options
Output Fields:
Output fields returned in GET results are the same names used for the possible Arguments when appending
each possible URI Parameter to 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 only) when validation of input parameter(s) fail:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<response><code>10</code><result>failure</result><message>the downlink frequency band did
not match the LO frequency band</message></response>
Input with valid 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>12.31></dnlkfreq></rf><rf><port>2</port><dnlkfreq>3.40</dnlkfreq></rf></input>"
"https://192.168.0.1/ws/v2/service_cfg/input"
Expected output (values are for example purposes only) when validation of input parameter(s) pass:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<response><code>10</code><result>success</result><message></message></response>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
136
API Definitions
Input Configuration Command

Input (Setting Parameters using body data from XML File):

curl -k -X POST -H "X-SESSION-ID: $token" --header "Content-type:application/xml" -d
@"C:/projects/input.xml" "https://192.168.0.1/ws/v2/service_cfg/input"
Input File "input.xml" contains data as shown below:
<input>
<rf>
<port>1</port>
<act>Yes</act>
<dnlkfreq>12.31</dnlkfreq>
</rf>
<rf>
<port>2</port>
<act>No</act>
<dnlkfreq>3.40</dnlkfreq>
</rf>
<asi>
<port>1</port>
<act>No</act>
</asi>
</input>
Expected output (values are for example purposes only) when validation of input parameter(s) pass:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<response><code>10</code><result>success</result><message></message></response>
GET (Settings Read) Examples:
Input (Request read back all input settings in XML format):
curl -k -H "X-SESSION-ID: $token" "https://192/168.0.1/ws/v2/service_cfg/input"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<input><rf><port>1</port><act>Yes</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>10.75</lo1><lo2>0.0</lo2><xover>0.0</xover><pol>Horizontal</pol><orbpos>0.0</orbpos>
<ewflag>N/A</ewflag><afcrange>3.0</afcrange><strm1sel>Yes</strm1sel><strm2sel>No</strm2sel>
<strm3sel>No</strm3sel><strm4sel>No</strm4sel><strm5sel>No</strm5sel><strm6sel>No</strm6sel>
<acqmode>Basic</acqmode><netid>1</netid><freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode>
<niten>Yes</niten><sdten>Yes</sdten><paten>Yes</paten></rf><rf><port>2</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>10.75</lo1>
<lo2>0.0</lo2><xover>0.0</xover><pol>Horizontal</pol><orbpos>0.0</orbpos><ewflag>N/A</ewflag>
<afcrange>3.0</afcrange><strm1sel>Yes</strm1sel><strm2sel>No</strm2sel><strm3sel>No</strm3sel>
<strm4sel>No</strm4sel><strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode>
<netid>1</netid><freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten>
<sdten>Yes</sdten><paten>Yes</paten></rf><rf><port>3</port><act>No</act><dnlkfreq>12.31</dnlkfreq>
<symrate>30.0</symrate><fec>Auto</fec><mod>DVB-S2</mod><rolloff>Auto</rolloff><iq>Auto</iq>
<pwr>Off</pwr><sel22khz>Off</sel22khz><lo1>5.15</lo1><lo2>0.0</lo2><xover>0.0</xover>
<pol>Horizontal</pol><orbpos>0.0</orbpos><ewflag>N/A</ewflag><afcrange>3.0</afcrange>
<strm1sel>No</strm1sel><strm2sel>No</strm2sel><strm3sel>No</strm3sel><strm4sel>No</strm4sel>
<strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode><netid>1</netid>
<freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten><sdten>Yes</sdten>
<paten>Yes</paten></rf><rf><port>4</port><act>No</act><dnlkfreq>12.31</dnlkfreq>
<symrate>30.0</symrate><fec>Auto</fec><mod>DVB-S2</mod><rolloff>Auto</rolloff><iq>Auto</iq>
<pwr>Off</pwr><sel22khz>Off</sel22khz><lo1>5.15</lo1><lo2>0.0</lo2><xover>0.0</xover>
<pol>Horizontal</pol><orbpos>0.0</orbpos><ewflag>N/A</ewflag><afcrange>3.0</afcrange>
<strm1sel>No</strm1sel><strm2sel>No</strm2sel><strm3sel>No</strm3sel><strm4sel>No</strm4sel>
<strm5sel>No</strm5sel><strm6sel>No</strm6sel><acqmode>Basic</acqmode><netid>1</netid>
<freqmode>NIT</freqmode><svclstmode>Rigorous</svclstmode><niten>Yes</niten><sdten>Yes</sdten>
<paten>Yes</paten></rf><asi><port>1</port><act>No</act><acqmode>Basic</acqmode><netid>1</netid>
<freqmode>User
Cfg</freqmode><svclstmode>Rigorous</svclstmode><niten>No</niten><sdten>Yes</sdten>
<paten>Yes</paten></asi><moip><port>1</port><act>No</act><ipmode>SW Map</ipmode>
<fecmode>None</fecmode><usemcast>Yes</usemcast><mcastaddr>225.1.1.1</mcastaddr>
<tsdestport>49152</tsdestport><feccolport>49154</feccolport><fecrowport>49156</fecrowport>
<usrsrcaddr>Yes</usrsrcaddr><srcfltmode>None</srcfltmode><dejalg>VBR</dejalg><acqmode>Basic</acqmode>
<netid>1</netid><freqmode>User
Cfg</freqmode><svclstmode>Rigorous</svclstmode><niten>No</niten>
<sdten>Yes</sdten><paten>Yes</paten></moip></input>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
137
 API Definitions
Input Configuration Command

Note The parameter list for the configuration APIs in this and following sections are compliant with the UIC
tables in the D9800 software application, which may use some special characters that are non-compliant
with the allowed URL character set.
When using curl, URL strings that include arguments (the options after the ?) must be in quotes, as
discussed in HTTP Request Methods, on page 3. In this case, the conversion of special characters is
implicit.
However, when using a web browser, argument strings must be first converted to substitute URL safe
"escape" replacements for special, reserved characters (as discussed in rfc2396).
For example, in URL safe format, spaces that are embedded in the URL string would typically need to be
replaced by %20 (percent sign followed by the asci hex value equivalent of a space).
Since some parameters may have spaces or forward slashes or other reserved URL characters in them.
We recommend that the D9800 web GUI, and other similar implementations, pass the full URL string
through a safe-url character converter before issuing the command.

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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/rf

Command Information Allows RF tuning input settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/input/rf",
GET "https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1", or
GET "https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&dnlkfreq"

POST Syntax POST

"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=[port#]&dnlkfreq=<Freq>..."

URI Parameters (extension to the Command URL separated by /): N/A

URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
138
API Definitions
Input Configuration Command

Note Setting Parameters using command line arguments are limited to maximum of 26 arguments after the ?.

Note All of the URI Arguments below apply to both GET and POST. For GET, the URI arguments do not need
any values, except the port which must be specified. For POST the port 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.

Table 135: URI Query/Set Arguments

URI Argument Description

port (Key) 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
Note This does not refer to the NTC Ethernet ports, it refers specifically
to the RF ports.
stream (Key) Multi Input Stream ID. If not specified, default value of 1 is used
(optional) Type: Integer
This is not applicable to Values: 1..6 (RF)
Version 1.x

act Activate Input

Type: String
Values: "Yes" or "No"

dnlkfreq Downlink Frequency

Type: Float
Values: 0.0 .. 15.0

symrate Symbol Rate

Type: Float
Values: 1.0 .. 45.0

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
139
 API Definitions
Input Configuration Command

URI Argument Description

fec FEC Mode
Type: String
Values: "Auto", "1/2", "2/3", "3/4", "5/6", "7/8"
Modulation Type of DVB-S2 must use a FEC value of "Auto"

mod Modulation Type

Type: String
Values: "DVBS" or "DVB-S2"

rolloff Rolloff Factor

Type: String
Values: ".20", ".25", ".35", "Auto"

Iq IQ Mode
Type: String
Values: "Opposite", "Normal", "Auto"

pwr LNB Power

Type: String
Values: "Off", "13V", "18V", "H-NIT", "V-NIT"

sel22khz 22 KHz Selection

Type: String
Values: "Off", "On", "Auto"

lo1 LO Select 1
Type: Float
Values: 0.0 … 15.0

lo2 LO Select 2
Type: Float
Values: 0.0 … 15.0

xover Cross Over Frequency

Type: Float
Values: 0.0 … 15.0

pol Polarization
Type: String
Values: "Horizontal", "Vertical", "Auto"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
140
API Definitions
Input Configuration Command

URI Argument Description

orbpos Orbital Position
Type: Float
Values: 0.0 .. 360.0

ewflag East West Flag

Type: String
Values: "NA", "East", "West"

afcrange AFC Range Value

Type: Float
Values: 0.0 .. 5.0

strm1Sel Select Stream 1

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

strm2sel Select Stream 2

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

strm3sel Select Stream 3

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

strm4sel Select Stream 4

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

strm5sel Select Stream 5

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

strm6sel Select Stream 6

This is not applicable to Type: String
Version 1.x Values: "Yes" or "No"

acqmode PSI Acquisition Mode

Type: String
Values: "Auto", "Basic", "Custom"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
141
 API Definitions
Input Configuration Command

URI Argument Description

netid Network Identifier
Type: Integer
Values: 0 … 65535

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

Note "Degraded" is only available as a Write (POST) option. It is the
same as "Relaxed".
• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

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 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 the specific unit IP in use. This example changes the iq mode of RF 3 to Normal.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&verbose=1&iq=Normal"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
142
API Definitions
Input Configuration Command

If successful, the return body will be:

"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple RF Tuning Parameters
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 changes several RF port 3 tuning parameters. It will set the
IQ mode to Normal, sdten to Yes, paten to Yes and niten to No.
curl -X POST –i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&verbose=1&iq=Normal&paten=Yes&sdten=Yes&niten=No"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples
Example 3: GET the full RF tuning values for a specific RF 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 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 -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3"
If successful, the return body will be:
"input": {
"rf": {
"port": "3",
"act": "No",
"dnlkfreq": "12.31",
"symrate": "30.0",
"fec": "Auto",
"mod": "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",
"strm1sel": "Yes",
"strm2sel": "No",
"strm3sel": "No",
"strm4sel": "No",
"strm5sel": "No",
"strm6sel": "No",
"acqmode": "Basic",
"netid": "1",
"freqmode": "NIT",
"svclstmode": "Rigorous",
"niten": "No",
"sdten": "Yes",
"paten": "Yes"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
143
 API Definitions
Input Configuration Command

Example 4: GET a specific RF tuning value for a specific RF 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 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 one specific 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 argument the user wishes to retrieve. This example retrieves the IQ Mode 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 NOT
contain values.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&iq"
If successful, the return body will be:
"input": {
"rf": {
"port": "3",
"iq": "Normal"
}
}
Example 5: GET multiple RF tuning values for a specific RF 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 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 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 NOT contain values.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=3&iq&paten&sdten&niten"
If successful, the return body will be:
"input": {
"rf": {
"port": "3",
"iq": "Normal",
"niten": "No",
"paten": "Yes",
"sdten": "Yes"
}
}
Miscellaneous Examples
Example 6: URI Parameters are misspelled or missing
curl -i -k -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/inputrf?port=1&act=Yes&dnlkfreq=1.421&symrate=32&mod=DVB-S2"
Expected Output:
1) No XML output will be returned.
2) HTTP return code is not value 200 (HTTP_OK).

HTTP/1.1 404 Not Found

Date: Fri, 23 Oct 2015 19:26:40 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 404
Remedy:
Client software must always first check HTTP return code.
Re-check that URI parameters portion of the command (the part before the ?) is correctly input
In the above example, /inputrf should be /input/rf.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
144
API Definitions
Input Configuration Command

Example 7: URI Arguments are misspelled or invalid for the command

curl -i -k -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&act=Yes&dnlkfreq=1.421&symrate=32&mod=DVBS2"
Expected Output:
<?xml version="1.0" encoding="ISO-8859-1"
?><response><code>10</code><result>failed</result><message>Failed to set item Modulation
value DVBS2</message></response>
Remedy:
Re-check that URI Arguments portion of the command (the part after the ?) is correctly input.
Re-check that the URI Arguments or combinations are valid for the command.
In the above example, DVBS2 should be DVB-S2.
Example 8: URI Parameters and Arguments are valid for the command – in this case POST command:
curl -i -k -H "X-SESSION-ID: $token" -X POST
"https://192.168.0.1/ws/v2/service_cfg/input/rf?port=1&act=Yes&dnlkfreq=3.421&symrate=32&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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/asi

Command Information Allows ASI tuning input settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/input/asi", or
GET "https://192.168.0.1/ws/v2/service_cfg/input/asi?
port=[port#]&mip=<mip#>&act"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/asi?

port=[port#]&mip=<mip#>..."

URI Parameters (extension to the Command URL separated by /): N/A

Note Setting Parameters using command line arguments are limited to maximum of 26 arguments after
the ?.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
145
 API Definitions
Input Configuration Command

Note All of the URI Arguments below apply to both GET and POST. For GET, the URI arguments do not
need any values, except the port which must be specified. For POST the port 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.

Table 137: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

port (Key) Input Port to be configured
Type: Integer
Value: 2
Note This does not refer to the NTC Ethernet ports, it refers
specifically to the ASI ports
stream (Key) Multi Input Stream ID. If not specified, default value of 1 is used.
(optional) Type: Integer
This is not applicable to Version 1.x Value: 2

act Activate Input

Type: String
Values: "Yes" or "No"

acqmode PSI Acquisition Mode

Type: String
Values: "Auto", "Basic", "Custom"

netid Network Identifier

Type: Integer
Values: 0 … 65535

freqmode Frequency Tuning Mode

Type: String
Values: "NIT", "User Cfg"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
146
API Definitions
Input Configuration Command

URI Argument Description

svclstmode Service List Mode (Version 2.75 and later)
Note "Degraded" is only available as a Write (POST) option. It
is the same as "Relaxed".
• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type: String
• Values: "Rigorous", "Degraded"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

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 ASI 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. 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, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple ASI Tuning Parameters
The following example assumes that the user has successfully logged onto the unit, received the session id
and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
147
 API Definitions
Input Configuration Command

change the IP to the specific unit IP in use. This example changes several ASI port 1 tuning parameters. It
will set the acqmode to Auto, sdten to Yes, paten to Yes and niten to No.
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&sdten=Yes&acqmode=Auto&paten=Yes&niten=No"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 3: GET the full ASI tuning values 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 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 all of the ASI tuning settings for ASI port
1.

Note The user must always specify the port number in the URI.

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"
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 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 one specific parameter value from the ASI
tuning settings for ASI port 1.

Note The user must always specify the port number in the URI followed by the URI argument the user wishes
to retrieve. This example retrieves the acqmode 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.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/input/asi?port=1&acqmode"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
148
API Definitions
Input Configuration Command

If successful, the return body will be:

"input": {
"asi": {
"port": "1",
"acqmode": "Auto"
}
}
Example 5: GET multiple 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 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 ASI
tuning settings for ASI port 1.

Note 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 acqmode, sdten, niten and 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.

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 Configuration Command

Table 138: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/moip

Command Information Allows MOIP tuning input settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
149
 API Definitions
Input Configuration Command

Command Detail Description

GET Syntax One of the following:
GET "https://192.168.0.1/ws/v2/service_cfg/input/moip", or
GET "https://192.168.0.1/ws/v2/service_cfg/input/moip?
stream=[stream#]&act"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/moip?

stream=[stream#]&act=Yes..."

URI Parameters (extension to the Command URL separated by /): N/A

Note Setting Parameters using command line arguments are limited to maximum of 26 arguments after
the ?.
Note All of the URI Arguments below 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 seen below following the table.

Table 139: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (Key) Multi Input Path Stream ID.
(Mandatory) Type: Integer
Values: 1..32

act Activate Input

Type: String
Values: "Yes" or "No"

ipmode IP address selection method.

Type: String
Values: "SW Map" or "UserCfg"

fecmode FEC mechanism.

Type: String
Values: "None", "1D", or "2D"

usemcast Use multicast address.

Type: String
Values: "Yes" or "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
150
API Definitions
Input Configuration Command

URI Argument Description

mcastaddr Multicast address.
Type: String
Values: IP address in the dot format, etc 192.168.0.1

tsdestport Transport destination port value.

Type Integer
Values: 1..65534

feccolport FEC column port value.

Type: Integer
Values: 1..65534

fecrowport FEC row port value.

Type: Integer
Values: 1..65534

usrsrcaddr User configured source IP address.

Type String
Values: IP address in the dot format, for example: 192.131.244.10

srcfltmode Source IP address filtering mode.

Type: String
Values: "None", "White List", "Black List"

dejalg Dejitter Algorithm.

Type: String
Values: "CBR" or "VBR"

avlostrig Redundancy Trigger on Audio/Video Loss.

Type: String
Values: "Yes" , "No"

pcrlostrig Redundancy Trigger on PCR Loss.

Type: String
Values: "Yes" , "No"

pmtlostrig Redundancy Trigger on PMT Loss.

Type: String
Values: "Yes" , "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
151
 API Definitions
Input Configuration Command

URI Argument Description

lnklostrig Redundancy Trigger on Link Loss.
Type: String
Values: "Yes"
Note This value is
read-only.
tslostrig Redundancy Trigger on Transport Loss.
Type: String
Values: "Yes"
Note This value is
read-only.
acqmode PSI acquisition mode.
Type: String
Values: "Auto", "Basic", "Custom"

netid Network identifier.

Type: Integer
Values: 0 … 65535

freqmode Frequency tuning mode.

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

Note "Degraded" is only available as a Write (POST) option. It is the
same as "Relaxed".
• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

niten Enable NIT reception.

Type: String
Values: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
152
API Definitions
Input Configuration Command

URI Argument Description

sdten Enable SDT reception.
Type: String
Values: "Yes", "No"

paten Enable PAT reception.

Type: String
Values: "Yes", "No"

dejlat Dejitter Buffer Latency

Type: Integer
Values: 40 … 150

ipiport IPI Port

Type: String
Values: "Data1", "Data2", "Data3", "Data4"

redenb nput Redundancy Mode

Type: String
Values: "Yes", "No"

reddir IPI Redundancy Switch Over Direction

Type: String
Values: "Non-Revertive", "Revertive"

reddel Direct Redundancy Switch Over Delay in milliseconds

Type: Integer
Values: 0 … 10000

redrev Revertive Redundancy Switch Over Delay in seconds

Type: Integer
Values: 0 … 30

cmdrow Add or Delete an instance of IP Input

Type: String
Values: "Add” (R/W), "Delete" (R/W), "Active" (RO), "Inactive" (RO)

Output Fields:
Output fields returned in GET results are the same names used for the possible arguments for this command.
POST Examples:

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
153
 API Definitions
Input Configuration Command

Example 1: Changing one MOIP 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. You must
change the IP to the specific unit IP in use. This example changes the freqmode of MOIP stream 1 to NIT.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip?stream=1&freqmode=NIT"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple MOIP Tuning Parameters
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 several MOIP stream 1 tuning parameters.
It will set the freqmode to NIT, sdten to Yes, paten to Yes and niten to No.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip?stream=1&paten=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 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 all of the MOIP tuning settings for MOIP
stream 1.

Note The user must always specify the stream number in the URI.

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?stream=1"
If successful, the return body will be:
"input": {
"moip": {
"stream": "1",
"act": "Yes",
"ipmode": "SW Map",
"fecmode": "None",
"usemcast": "Yes",
"mcastaddr": "225.1.1.1",
"tsdestport": "49152",
"feccolport": "49154",
"fecrowport": "49156",
"usrsrcaddr": "Yes",
"srcfltmode": "None",
"dejalg": "VBR",
"acqmode": "Basic",
"netid": "1",
"freqmode": "NIT",
"svclstmode": "Rigorous",
"niten": "No",
"sdten": "Yes",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
154
API Definitions
Input Configuration Command

"paten": "Yes"
}
}
Example 4: GET a specific 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 one specific parameter value from the
MOIP tuning settings for MOIP stream 1.

Note The user must always specify the stream number in the URI followed by the URI argument the user wishes
to retrieve.

This example retrieves the freqmode from MOIP stream 1. In GET URIs only the stream argument must
contain a value for the stream, all other arguments do not contain values.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip?stream=1&freqmode"
If successful, the return body will be:
"input": {
"moip": {
"stream": "1",
"freqmode": "NIT"
}
}
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 settings for MOIP stream 1.

Note The user must always specify the stream number in the URI followed by the URI arguments the user
wishes to retrieve.

This example retrieves the freqmode, sdten, niten and paten values from MOIP stream 1. In GET URIs only
the stream argument must contain a value for the stream, all other arguments do not contain values.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip?stream=1&paten&sdten&freqmode&niten"
If successful, the return body will be:
"input": {
"moip": {
"stream": "1",
"freqmode": "NIT",
"niten": "Yes",
"paten": "Yes",
"sdten": "Yes"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
155
 API Definitions
Input Configuration Command

MOIP Input Source Filters Configuration Command

Table 140: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/moip/srcfilter

Command Information Allows MOIP source filter settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/input/moip", or
GET "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcfilter? idx=5"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcfilter?

idx=3&ip=192.131.244.113&oper=Add"

URI Parameters (extension to the Command URL separated by /): N/A

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

Table 141: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

idx (Key) Filter slot to be configured
Type: Integer
Values: 1 to 8

ip IP Address
Type : String
Values : IP address in the dot format, for example, 192.168.0.1

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
156
API Definitions
Input Configuration Command

URI Argument Description

oper Filter index operation
Type: String
Value: "Add", "Delete"
Use "Add" to modify an existing entry

POST Examples:
Example 1: Changing both MOIP Source Filter 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 both the ip address of filter slot 1 and its
filter index operation (oper).
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip/srcfilter?idx=1&ip=10.10.10.10&oper=Add"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
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 -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip/srcfilter"
If successful, the return body will be:
HTTP/1.1 200 OK
Date: Fri, 29 Jul 2016 02:43:54 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/json
{
"srcfilter": {
"record": [
{
"idx": "1",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "2",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "3",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "4",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
157
 API Definitions
Input Configuration Command

"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "5",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "6",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "7",
"ip": "0.0.0.0",
"oper": "Inactive"
},
{
"idx": "8",
"ip": "0.0.0.0",
"oper": "Inactive"
}
]
}
}
To retrieve the table for a specific idx the CURL would look like:
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/srcfilter?idx=1"

MOIP Input Source Select Configuration Command

Table 142: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect

Command Information Allows MOIP source select settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect", or

GET "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect?
stream=[stream#]&idx=[index#]"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect?

stream=[stream#]&dat1srcaddr=10.10.10.10..."

URI Parameters (extension to the Command URL separated by /): N/A

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
158
API Definitions
Input Configuration Command

Table 143: URI Query Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

streamid (Key) Stream ID
Type: Integer
Values: 1 … 32

idx (Key) Index

Type: Integer
Values: 1 … 64

ip IP Address
Type: String
Values: IP address in the dot format, e.g. 192.168.0.1

data1sel DATA1 selection state. DATA1 is either selected or not selected.

Type: String
Value: "Yes", "No"

data1avail IP is present in the DATA1 stream.

Type: String
Value: "Yes", "No"

data1Enabled Allow DATA1 to be selected or not.

Type: String
Value: "Yes", "No"

data2sel DATA2 selection state. DATA2 is either selected or not selected.

Type: String
Value: "Yes", "No"

data2avail IP is present in the DATA2 stream.

Type: String
Value: "Yes", "No"

data2Enabled Allow DATA2 to be selected or not.

Type: String
Value: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
159
 API Definitions
Input Configuration Command

URI Argument Description

data3sel DATA3 selection state. DATA3 is either selected or not selected.
Type: String
Value: "Yes", "No"

data3avail IP is present in the DATA3 stream.

Type: String
Value: "Yes", "No"

data3Enabled Allow DATA3 to be selected or not.

Type: String
Value: "Yes", "No"

data4sel DATA4 selection state. DATA4 is either selected or not selected.

Type: String
Value: "Yes", "No"

data4avail IP is present in the DATA4 stream.

Type: String
Value: "Yes", "No"

data4Enabled Allow DATA4 to be selected or not.

Type: String
Value: "Yes", "No"

Table 144: URI Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (Key) Stream ID
Type: Integer
Values: 1 … 32

dat1srcaddr Set the IP address to lock from DATA1.

Type: String
Value: IP address in the dot format, for example, 192.168.0.1

dat2srcaddr Set the IP address to lock from DATA2.

Type: String
Value: IP address in the dot format, for example, 192.168.0.1

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
160
API Definitions
Input Configuration Command

URI Argument Description

dat3srcaddr Set the IP address to lock from DATA3.
Type: String
Value: IP address in the dot format, for example, 192.168.0.1

dat4srcaddr Set the IP address to lock from DATA4.

Type: String
Value: IP address in the dot format, for example, 192.168.0.1

POST Examples:
Example 1: Changing MOIP Data Source IP Addresses
This example changes the IP address to lock from DATA1 to 10.10.10.10 and the IP address to lock from
DATA2 to 10.10.10.11.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/moip/srcselect?stream=1&dat1srcaddr=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"
If successful, the return body will be:
{
"srcselect": {
"record": {
"streamid": "1",
"idx": "1",
"ip": "0.0.0.0",
"data1sel": "No",
"data1avail": "No",
"data1Enabled": "No",
"data2sel": "No",
"data2avail": "No",
"data2Enabled": "No",
"data3sel": "No",
"data3avail": "No",
"data3Enabled": "No",
"data4sel": "No",
"data4avail": "No",
"data4Enabled": "No"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
161
 API Definitions
ABR Input Configuration Command

ABR Input Configuration Command

Table 145: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/abr

Command Information Allows ABR input settings to be read or configured.

HTTP Method(s) GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input/abr", or

GET "https://192.168.0.1/ws/v2/service_cfg/input/abr?
stream=[stream#]"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/abr?

stream=[stream#]&cmdrow=Add..."

URI Parameters (extension to the Command URL separated by /): N/A

Note Setting Parameters using 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 seen below following the table.

Table 146: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

URI Argument Description

stream (Key) Multi Input Stream ID
Type: Integer
Values: 1..32

act Activate Input

Type: String
Values: "Yes" or "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
162
API Definitions
ABR Input Configuration Command

URI Argument Description

netid Network Identifier
Type: Integer
Values: 0 … 65535

acqmode Select which tables are required for service list creation.
Type: String
Values: "Basic", "Auto", "Custom","FixPID"

camode Select how programs that are marked as encrypted --and can not
be decrypted-- are handled.
Type: String
Values: "Std", "Open"

inputsel Input Selection

Type: String
Values: "UserCfg", "SW Map"

freqmode Enable SDT Reception

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

Note "Degraded" is only available as a Write (POST) option
for backwards compatibility. It is the same as "Relaxed".
• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

baten Enable BAT Reception

Type: String
Values: "Yes", "No"

niten Enable NIT Reception

Type: String
Values: "Yes", "No”

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
163
 API Definitions
ABR Input Configuration Command

URI Argument Description

sdten Enable SDT Reception
Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

name ABR settings name

Type: String
Value: Up to 12 characters

url ABR settings URL

Type: String
Value: Up to 200 characters

latency ABR settings target latency

Type: Integer
Values: 0.. 4294967295

phyport ABR settings physical port

Type: String
Values: "Mngmt", "Data1", "Data2", "Data3", "Data4"

cmdrow Add or Delete an instance of ABR Input

Type: String
Values: "Add" (R/W), "Delete" (R/W), "Active" (RO), "Inactive"
(RO)

minlatency ABR settings minimum latency

Type: Integer
Values: 0.. 4294967295

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 session id,
and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
164
API Definitions
ABR Input Configuration Command

change the IP to the specific unit IP in use. The following example changes the name of an existing ABR
entry to "Prog5".
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/abr?stream=2&name=Prog5
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple ABR Parameters
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 changes several ABR 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/abr?stream=2&netid=12345&sdten=Yes&paten=Yes&niten=Yes"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 3: GET the full ABR tuning values for a 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: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/abr?stream=2"
If successful, the return body will be:
"input": {
"abr": {
"stream": "2",
"act": "No",
"netid": "1",
"camode": "Std",
"inputsel": "UserCfg",
"freqmode": "User Cfg",
"svclstmode": "Rigorous",
"baten": "No",
"niten": "No",
"sdten": "Yes",
"paten": "Yes",
"name": "ABR2",
"url": "",
"latency": "0",
"phyport": "Mngmt",
"cmdrow": "Inactive",
"minlatency": "0"
}
}
Example 4: GET a specific ABR value for a 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 one specific parameter value,
camode, from the ABR settings for ABR stream 2.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
165
 API Definitions
Zixi Input Configuration Command

Note In GET URIs only, the entry selection argument (stream) must contain a value, all other arguments DO
NOT contain values.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/input/abr?stream=2&camode&js=1"
If successful, the return body will be:
"input": {
"abr": {
"stream": "2",
"camode": "Std" }
}
Example 5: GET multiple ABR tuning value for a specific ABR 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 values from the ABR
settings. This example retrieves the camode, sdten, niten and paten values from ABR stream 2.

Note In GET URI’s only the entry selection argument (stream) must contain a value, all other arguments DO
NOT contain values.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/input/abr?stream=2&camode&sdten&paten&niten&js=1"
If successful, the return body will be:
"input": {
"abr": {
"stream": "2",
"camode": "Std",
"niten": "No",
"paten": "Yes",
"sdten": "Yes" }
}

Zixi Input Configuration Command

Table 147: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/input/zixi

Command Information Allows ZIXI input settings to be read or configured.

HTTP Methods GET, POST

Access Type Read/Write (with complex input data)

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
166
API Definitions
Zixi Input Configuration Command

Command Detail Description

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/input/zixi", or
GET "https://192.168.0.1/ws/v2/service_cfg/input/zixi?
stream=[stream#]"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/input/zixi?

stream=[stream#]&cmdrow=Add..."

URI Parameters (extension to the Command URL separated by /): N/A

Note Setting Parameters using 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 seen below following the table.

Table 148: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

stream (Key) Multi Input Stream ID
Type: Integer
Values: 1..32

act Activate Input

Type: String
Values: "Yes" or "No"

netid Network Identifier

Type: Integer
Values: 0 … 65535

acqmode Select which tables are required for service list creation.
Type: String
Values: "Basic", "Auto", "Custom","FixPID"

camode Select how programs that are marked as encrypted (and can not
be decrypted) are handled.
Type: String
Values: "Std", "Open"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
167
 API Definitions
Zixi Input Configuration Command

URI Argument Description

inputsel Input Selection
Type: String
Values: "UserCfg", "SW Map"

freqmode Enable SDT Reception

Type: String
Values: "NIT", "User Cfg"

svclstmode Service List Mode (Version 2.75 and later)

Note "Degraded" is only available as a Write (POST) option
for backwards compatibility (means the same as
"Relaxed")
• Type : String
• Values : "Rigorous", "Relaxed"

Service List Mode (Version 2.50 and earlier)

• Type : String
• Values : "Rigorous", "Degraded"

baten Enable BAT Reception

Type: String
Values: "Yes", "No"

niten Enable NIT Reception

Type: String
Values: "Yes", "No"

sdten Enable SDT Reception

Type: String
Values: "Yes", "No"

paten Enable PAT Reception

Type: String
Values: "Yes", "No"

Name (RO) ZIXI settings name

Type: String
Value: Up to 12 characters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
168
API Definitions
Zixi Input Configuration Command

URI Argument Description

type ZIXI Type
Type: String
Value: "None", "Pull"

source ZIXI input source such as a URL

Type: String
Value: Up to 200 characters

sid Source Stream ID

Type: String
Value: Up to 200 characters

protport Source Port

Type: Integer
Values: 0 … 65535

interface ZIXI settings physical interface

Type: String
Values: "Mngmt", "Data1", "Data2", "Data3", "Data4"

rowstatus Add or Delete an instance of ZIXI Input

Type: String
Values: "Add" (R/W), "Delete" (R/W), "Active" (RO), "Inactive"
(RO)

latency ZIXI input stream latency

Type: Integer
Values: 0.. 4294967295

decrkey Descrambling key for ZIXI Input Stream

Type: String
Value: Up to 64 characters

redmode Redundancy Mode

Type: String
Values: "Yes", "No"

redsource Redundancy Backup ZIXI input source such as a URL

Type: String
Value: Up to 200 characters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
169
 API Definitions
Zixi Input Configuration Command

URI Argument Description

redsid Redundancy Backup Source Stream ID
Type: String
Value: Up to 200 characters

redprotport Redundancy Backup Source Port

Type: Integer
Values: 0 … 65535

reddecrkey Descrambling key for Redundancy Backup ZIXI Input Stream

Type: String
Value: Up to 64 characters

fecmode Forward Error Correction Mode

Type: String
Values: "Off", "On", "Adaptive"

fecovhd Forward Error Correction Overhead

Type: Integer
Values: 0 … 10000

fecblkms Forward Error Correction Block

Type: Integer
Values: 0 … 10000

fecconawar Forward Error Correction Content Aware

Type: String
Values: "Yes", "No"

fecmaxjitr Forward Error Correction Maximum Jitter

Type: Integer
Values: 0 … 10000

fecstufnul Forward Error Correction Stuff Null

Type: String
Values: "Yes", "No"

latmode Latency Mode

Type: String
Values: "Static", "Increasing", "Dynamic"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
170
API Definitions
Zixi Input Configuration Command

URI Argument Description

adaptmode Adaptive Mode
Type: String
Values: "None", "Encoder", "FEC"

Output Fields:
Output fields returned in GET results are the same names used for the possible Arguments for this command.
POST Examples:
The following examples assume 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
Example 1: Changing one ZIXI Parameter
The following example changes the type of an existing ZIXI entry to Pull mode".
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&type=Pull"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
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": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 3: GET the full ZIXI tuning values for a specific ZIXI entry
This example retrieves all of the ZIXI settings for stream 2.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/input/zixi?stream=2"
If successful, the return body will be:
"input": {
"zixi": {
"stream": "2",
"act": "Yes",
"netid": "1",
"acqmode": "Auto",
"camode": "Std",
"inputsel": "UserCfg",
"freqmode": "User Cfg",
"svclstmode": "Rigorous",
"baten": "No",
"niten": "No",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
171
 API Definitions
Zixi Input Configuration Command

"sdten": "Yes",
"paten": "Yes",
"name": "ZIXI1",
"type": "Pull",
"source": "zixi://tor02lab-s-002.cisco.com",
"sid": "cisco-CAN",
"protport": "2077",
"interface": "Mngmt",
"rowstatus": "Active",
"latency": "5000",
"decrkey": "",
"redmode": "No",
"redsource": "",
"redsid": "",
"reddecrkey": "",
"fecmode": "On",
"fecovhd": "30",
"fecblkms": "50",
"fecconawar": "No",
"fecmaxjitr": "0",
"fecstufnul": "No",
"latmode": "Static",
"adaptmode": "None"
}
}
Example 4: GET a specific ZIXI value for a specific ZIXI entry
This example retrieves one specific parameter value, camode, from the ZIXI settings for ZIXI stream 1.

Note In GET URIs, only the entry selection argument (stream) must contain a value, all other arguments DO
NOT contain values.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/input/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.

Note In GET URIs, only the entry selection argument (stream) must contain a value, all other arguments DO
NOT contain values.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/input/zixi?stream=2&camode&sdten&paten&niten&js
=1"
If successful, the return body will be:
"input": {
"zixi": {
"stream": "1",
"camode": "Std",
"niten": "No",
"paten": "Yes",
"sdten": "Yes" }
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
172
 API Definitions
PE Configuration Command

PE Configuration Command
Table 149: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/pe

Command Information Allows set or get of PE information.

HTTP Methods GET, POST

Access Type Read/Write

Access Level User, Admin

GET Syntax One of the following:

GET https://192.168.0.1/ws/v2/service_cfg/pe, or
GET "https://192.168.0.1/ws/v2/service_cfg/pe? peid=[peid#]"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/pe?

peid=[peid#]&chn=[chn#]"

URI Parameters (extension to the Command URL separated by /): N/A

For GET, the URI arguments do not need any values to dump info for all PEs. To GET info for a specific PE,
specify 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 &)

URI Argument Description

peid (key) Program Entry Identifier
Type: Integer
Value: 1..32
When not specified on a GET, all PEs are returned.

chn Channel Number to be configured on this Program Entry

Type: Integer
No value required on GET (but may be used as filter for requested output,
eg &chn&…)
POST Values: 0 .. 65535

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
173
 API Definitions
PE Configuration Command

URI Argument Description

inp Input port name
Type: String
No value required on GET (but may be used as filter for requested output,
eg &inp&…)
POST Values: RF1..RF4, ASI1..AS2, MOIP1..MOIP32, ABR1..ABR32
Single-Stream target: RF1-RF4, MOIP, ASI
Multi-Stream target: RF1-RF4, MOIP1,MOIP2, ASI1, ASI2

js Format output using JSON standard (applies to command line input only)
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

Table 151: Output Field Descriptions

Output Field Description

peid Program Entry Identifier
Type: Integer
Value: 1..32

chn Channel Number to be configured on this Program

Entry
Type: Integer
Values: 0 .. 65535

inp Input port name

Type: String
Values:
Single-Stream target: RF1-RF4, MOIP, ASI
Multi-Stream target: RF1-RF4, MOIP1,MOIP2, ASI1,
ASI2

GET Method Examples

Use to display PE information in the format of XML or JSON, which is based on input parameters.
Input (GET all PE Info and request default XML format output):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
174
API Definitions
PE Configuration Command

Expected output (values are for example purposes only):

<?xml version="1.0" encoding="ISO-8859-1" ?>
<pe>
<record><peid>1</peid><chn>802</chn><inp>RF1</inp></record>
<record><peid>2</peid><chn>0</chn><inp> </inp></record>
<record><peid>3</peid><chn>0</chn><inp> </inp></record>
<record><peid>4</peid><chn>0</chn><inp> </inp></record>
<record><peid>5</peid><chn>0</chn><inp> </inp></record>
<record><peid>6</peid><chn>0</chn><inp> </inp></record>
<record><peid>7</peid><chn>0</chn><inp> </inp></record>
<record><peid>8</peid><chn>0</chn><inp> </inp></record>
<record><peid>9</peid><chn>0</chn><inp> </inp></record>
<record><peid>10</peid><chn>0</chn><inp> </inp></record>
<record><peid>11</peid><chn>0</chn><inp> </inp></record>
<record><peid>12</peid><chn>0</chn><inp> </inp></record>
<record><peid>13</peid><chn>0</chn><inp> </inp></record>
<record><peid>14</peid><chn>0</chn><inp> </inp></record>
<record><peid>15</peid><chn>0</chn><inp> </inp></record>
<record><peid>16</peid><chn>0</chn><inp> </inp></record>
<record><peid>17</peid><chn>0</chn><inp> </inp></record>
<record><peid>18</peid><chn>0</chn><inp> </inp></record>
<record><peid>19</peid><chn>0</chn><inp> </inp></record>
<record><peid>20</peid><chn>0</chn><inp> </inp></record>
<record><peid>21</peid><chn>0</chn><inp> </inp></record>
<record><peid>22</peid><chn>0</chn><inp> </inp></record>
<record><peid>23</peid><chn>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</peid><chn>0</chn><inp> </inp></record>
</pe>
Input (GET all PE Info and request JSON format output):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe?js=1"
Expected output (values are for example purposes only):
{
"pe": {
"record": [
{
"peid": "1",
"chn": "802",
"inp": "RF1"
},
// data for items peid: 2 to peid: 31 omitted to save space in document
{
"peid": "32",
"chn": "0",
"inp": " "
}
]
}
}
Input (GET single PE Info and request default XML format output):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe?peid=1"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<pe>
<record><peid>1</peid><chn>802</chn><inp>RF1</inp></record>
</pe>
Input (GET single PE peid and chn info only and request JSON format output):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/pe?peid=1&chn&js=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
175
 API Definitions
PE Configuration Command

Expected output (values are for example purposes only):

{
"pe": {
"record": {
"peid": "1",
"chn": "802"
}
}
}
POST Method Examples:
Use to Configure PE, XML and JSON are supported from the post file.
XML from file Example:
File contents of temp.xml:
<pe><record><peid>1</peid><chn>801</chn><inp>RF1</inp></record></pe>
Input (POST PE configuration info via file temp.xml):
curl -k -X POST -H "X-SESSION-ID: $token" --header "Content-Type:application/xml" -d
@"C:/projects/temp.xml" "https://192.168.0.1/ws/v2/service_cfg/pe"
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>
JSON from file Example:
File contents 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 41 the following CURL
command applies:
Input (POST PE specific peid configuration info via command line):
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k "https://
192.168.0.1/ws/v2/service_cfg/pe?peid=1&chn=41"
Expected output (values are for example purposes only):
{
"response": {
"code": "10",
"result": "success",
"message": ""
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
176
 API Definitions
Output Configuration Command

Output Configuration Command

Table 152: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/output

Command Information Allows set or get of output configuration parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/output"

POST Syntax POST --header "Content-type:application/xml" -d

@"C:\projects\output.xml" "https://192.168.0.1/ws/v2/service_cfg/output?
peid=[peid#]&chn=[chn#]"

URI Parameters (extension to the Command URL separated by /): N/A

Table 153: XML/JSON file input arguments and Output Fields

Port Name Description

asi Type: String
moip Valid output port names for Phase 1 (single-stream) units only

asi1 Type: String

asi2 Valid output port names for multi-stream units
moip1
moip2

Table 154: ASI, ASI1, or ASI2 Next level names (after Port Name)

ASI, ASI1, or ASI2 Next Level Name Description

mode Output Mode
Type: String
Values: "No Output", "Passthrough", "Service Channels Only", "Map
Passthrough", "Map Service Channels Only", "Transcoding"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
177
 API Definitions
Output Configuration Command

ASI, ASI1, or ASI2 Next Level Name Description

dscrmode Output Descrambling Mode
Type: String
Values: "Descrambled", "Scrambled"

ratemode Output Rate Control Mode

Type: String
Value: "User"

rate Output Rate

Type: Float
Values: 0.0 ….. 206.0

insertnul Insert Null Packet

Type: String
Values: "Yes", "No"
insertnul="No" is not allowed with ratemode="User"

pe peid 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)

action PE Action
Type: String
Values: "Drop", "Pass", "Map", "XCode"

pmtpid Output PMT PID

Type: Integer
Values: 0..8191

outchan Output Channel Number

Type: Integer
Values: 0..65535

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
178
API Definitions
Output Configuration Command

Table 155: MOIP, MOIP1, or MOIP2 Next level names (after Port Name)

MOIP, MOIP1, or MOIP2 Next Level Description

Name
mode Output Mode
Type: String
Values: "No Output", "Passthrough", "Service Channels Only", "Map
Passthrough", "Map Service Channels Only", "Transcoding"

dscrmode Output Descrambling Mode

Type: String
Values: "Descrambled", "Scrambled"

ratemode Output Rate Control Mode

Type: String
Value: "User"

rate Output Rate

Type: Float
Values: 0.0 ….. 206.0

insertnul Insert Null Packet

Type: String
Values: "Yes", "No"
insertnul="No" is not allowed with ratemode="User"

mcastip Set valid SAP destination IP address (multicast only)

Type: String
Value: IP address in dot format, for example, 224.2.127.254

destport Set the SAP UDP destination port number

Type: Integer
Value: 1024..65534

fecscheme FEC arrangement : Block-aligned (0) or Non Block-aligned

Type: String
Values: "Block Aligned", "Non-Block Aligned"

tpperframe Set the number of transport packets to be sent per IP packet

Type: Integer
Value: 1..7

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
179
 API Definitions
Output Configuration Command

MOIP, MOIP1, or MOIP2 Next Level Description

Name
redunmode Redundancy Mode
Type: String
Values: "Mirroring", "Backup: First Port", "Backup: Second Port",
"Manual: First Port", "Manual: Second Port"

redundir Switchover direction

Type: String
Values: "Non-Revertive", "Revertive"

redundelfwd Delay before switching from Main to Backup port, in ms

Type: Integer
Value: 0..10000

redundelbck Delay before switching from Backup to Main port, in sec

Type: Integer
Value: 0..120

pe peid 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)

action PE Action
Type: String
Values: "Drop", "Pass", "Map", "XCode"

pmtpid Output PMT PID

Type: Integer
Values: 0..8191

outchan Output Channel Number

Type: Integer
Values: 0..65535

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
180
API Definitions
Output Configuration Command

MOIP, MOIP1, or MOIP2 Next Level Description

Name
ipo ipoid 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

iporate Bitrate (in Mbps) of Transport output stream

Type: Float
Values: 0.0…800.0

encaps Encapsulation of Transport output stream

Type: String
Values: "RTP", "UDP"

dest_ip Destination IP Address

Type: String
Values: IP address in the dot format, for
example, 192.168.0.1

dest_port Destination IP Port

Type: Integer
Values: 1..65534

toc Traffic Class

Type: Integer
Values: 0..255

ttl Time To Live

Type: Integer
Values: 0..255

src_port Source UDP Port

Type: Integer
Values: 0..65534
src_port = 0 means use default UDP port

ann_type Announce Type

Type: String
Values: "None", "RFC 2327"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
181
 API Definitions
Output Configuration Command

MOIP, MOIP1, or MOIP2 Next Level Description

Name
ann_src Announce Title Source
Type: String
Values: "User String", "SDT Channel"

ann_title Announce User’s Title

Type: String
Values: Up to 32 characters

fec_mode EC Mode
Type: String
Values: "None", "1D","2D"
fec_col Fec Columns Depth
Type: Integer
Values: 1..20

fec_row Fec Rows Depth

Type: Integer
Values: 4..20

fec_colport FEC Columns UDP Port

Type: Integer
Values: 1..65534

fec_rowport FEC Rows UDP Port

Type: Integer
Values: 1..65534

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
182
API Definitions
Output Configuration Command

Table 156: Additional arguments (preceded by ? and separated by & on command line)

Argument Description
resync Resynchronize ALL PE Output (applies to POST syntax only)
Type: Integer
Value: 1..4
1: Resynchronize Program, PMT PID, ES list & ES PIDs
2: Resynchronize ES list
3: Resynchronize ES PIDs
4: Resynchronize Template ES List & PIDs
Note Currently, only value 1 is supported. All the other inputs
(2, 3, and 4) are handled as 1.
js 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.

Example Read (GET) commands (results for single-stream unit shown):

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/service_cfg/output"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<output><asi><mode>Service Channels Only</mode><dscrmode>Descrambled</dscrmode><ratemode>User
</ratemode><rate>68.5</rate><insertnul>Yes</insertnul><pe><peid>PE1</peid><action>Pass</action>
<pmtpid>5801</pmtpid><outchan>801</outchan></pe><pe><peid>PE2</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE3</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE4</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE5</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE6</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE7</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE8</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE9</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE10</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE11</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE12</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE13</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE14</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE15</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe><pe><peid>PE16</peid><action>Pass</action>
<pmtpid>8191</pmtpid><outchan>0</outchan></pe></asi><moip><mode>Service Channels Only</mode>
<dscrmode>Descrambled</dscrmode><ratemode>User</ratemode><rate>68.5</rate>
<insertnul>Yes</insertnul><mcastip>224.2.127.254</mcastip><destport>9875</destport>
<fecscheme>Block Aligned</fecscheme><tpperframe>7</tpperframe>
<redunmode>Backup: First Port</redunmode><redundir>Revertive</redundir>
<redundelfwd>0</redundelfwd><redundelbck>1</redundelbck><pe><peid>PE1</peid>
<action>Pass</action><pmtpid>5801</pmtpid><outchan>801</outchan></pe><pe>
<peid>PE2</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE3</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE4</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE5</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE6</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE7</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
183
 API Definitions
Output Configuration Command

</pe><pe><peid>PE8</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE9</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE10</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE11</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE12</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE13</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE14</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE15</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe><pe><peid>PE16</peid><action>Pass</action><pmtpid>8191</pmtpid><outchan>0</outchan>
</pe></moip></output>
Example Write (POST) commands:
Setting parameters using XML body data from command line (for single-stream unit shown):
curl -k -X POST -H "X-SESSION-ID: $token" --header "Content-type:application/xml" -d
"<output><asi><port>1</port><mode>Pass</mode></asi><moip><mode>No
Output</mode></moip></output>" "https://192.168.0.1/ws/v2/service_cfg/output"
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>
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</dscrmode>
</asi>
<moip>
<mode>No Output</mode>
<dscrmode>Descramble</dscrmode>
</moip>
</output>
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>

ASI Global Output Configuration Command

Table 157: Command Details

Command Detail Description

Command URL Single-stream (NTC Basic, NTC MOIP), asi output port (only one output
exists):
https://192.168.0.1/ws/v2/service_cfg/output/asi
Or, alternatively:
Single-stream (NTC Basic, NTC MOIP), asi output port (only one exists):
https://192.168.0.1/ws/v2/service_cfg/output/asi2
Multi-stream unit, asi output port 1:
https://192.168.0.1/ws/v2/service_cfg/output/asi1
Multi-stream unit, asi output port 2:
https://192.168.0.1/ws/v2/service_cfg/output/asi2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
184
API Definitions
Output Configuration Command

Command Detail Description

Command Information Allows set or get of ASI output parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax Single-stream unit:

GET "https://192.168.0.1/ws/v2/service_cfg/output/asi"
Multi-stream unit:
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi1", or
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi12?mode"

POST Syntax Single-stream unit:

POST --header "Content-type:application/xml" -d
@"C:\projects\output.xml"
"https://192.168.0.1/ws/v2/service_cfg/output/asi? mode=<mode>"
Note Setting Parameters using command line arguments is limited
to maximum of 26 arguments after the ?.
Multi-stream unit:
POST --header "Content-type:application/xml" -d
@"C:\projects\output.xml"
"https://192.168.0.1/ws/v2/service_cfg/output/asi1? mode=<mode>

URI Parameters (extension to the Command URL separated by /): N/A

Note 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 following the table.

Table 158: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

mode Output Mode
Type: String
Values: "No Output", "Passthrough", "Service Channels Only", "Map
Passthrough", "Map Service Channels Only", "Transcoding"

dscrmode Output Descrambling Mode

Type: String
Values: "Descrambled", "Scrambled"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
185
 API Definitions
Output Configuration Command

URI Argument Description

ratemode Output Rate Control Mode
Type: String
Value: "User"

rate Output Rate

Type: Float
Values: 0.0 ….. 206.0

insertnul Insert Null Packet

Type: String
Values: "Yes", "No"
insertnul="No" is not allowed with ratemode="User"

Table 159: Additional arguments (preceded by ? and separated by & on command line)

Argument Description
resync Resynchronize ALL PE Output
Type: Integer
Value: 1..4
1: Resynchronize Program, PMT PID, ES list & ES PIDs
2: Resynchronize ES list
3: Resynchronize ES PIDs
4: Resynchronize Template ES List & PIDs

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

Note 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 by %20, for
example: "https://192.168.0.1/ws/v2/service_cfg/output/asi?mode=Map%20Service%20Channels%20Only.

POST Examples:
Example 1: Set Various Output ASI Parameters

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
186
API Definitions
Output Configuration Command

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 output descrambling mode to
Descrambled and the ratemode to User.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/output/asi?dscrmode=Descrambled&ratemode=User"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
This is the same example being executed on a NTC MS unit:
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/output/asi1?dscrmode=Descrambled&ratemode=Auto"
GET Examples:
Example 2: Get full table of ASI 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 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",
"insertnul": "Yes",
"pe": [
{
"peid": "PE1",
"action": "Drop",
"pmtpid": "8191",
"outchan": "0"
},
{
"peid": "PE2",
"action": "Drop",
"pmtpid": "8191",
"outchan": "0"
}
]
}
}
This is the same example executed on a NTC multi-stream 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/asi2"
Example 3: Get specific ASI 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 specific unit IP in use. This example returns the specific ASI Output setting of the
descrambled mode (dscrmode) and Output Mode (mode) parameters.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
187
 API Definitions
Output Configuration Command

Note For GET arguments do not supply values.

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?&dscrmode&mode"
If successful, the return body will be:
"output": {
"asi": {
"dscrmode": "Descrambled",
"mode": "No Output"
}
}
}

MOIP Global Output Configuration Command

Table 160: Command Details

Command Detail Description

Command URL Single-stream (NTC Basic): MOIP is not supported.
Single-stream (NTC MOIP), one unique moip output available:
https://192.168.0.1/ws/v2/service_cfg/output/moip, or
https://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 Information Allows set or get of MOIP output parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/output/moip",
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1", or
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip2?mode"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
188
API Definitions
Output Configuration Command

Command Detail Description

POST Syntax Single-stream unit:
POST --header "Content-type:application/xml" -d
@"C:\projects\output.xml"
"https://192.168.0.1/ws/v2/service_cfg/output/moip? mode=<mode>"
Note Setting Parameters using command line arguments is limited
to maximum of 26 arguments after the ?.
Multi-stream unit:
POST --header "Content-type:application/xml" -d
@"C:\projects\output.xml"
"https://192.168.0.1/ws/v2/service_cfg/output/moip1? mode=<mode>

URI Parameters (extension to the Command URL separated by /): N/A

Note 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 following the table.

Table 161: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

mode Output Mode
Type: String
Values: "No Output", "Passthrough", "Service Channels Only", "Map
Passthrough", "Map Service Channels Only", "Full DPM Control",
"Transcoding", "SPTS Service Channels Only", "SPTS MAP Service
Channels Only", "SPTS Full DPM Control", "SPTS Transcoding"

dscrmode Output Descrambling Mode

Type: String
Values: "Descrambled", "Scrambled"

ratemode Output Rate Control Mode

Type: String
Value: "User"

rate Output Rate

Type: Float
Values: 0.0 ….. 206.0

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
189
 API Definitions
Output Configuration Command

URI Argument Description

insertnul Insert Null Packet
Type: String
Values: "Yes", "No"
insertnul="No" is not allowed with ratemode="User"

mcastip Set valid SAP destination IP address (multicast only)

Type: String
Value: IP address in dot format, for example, 224.2.127.254

destport Set the SAP UDP destination port number

Type: Integer
Value: 1024..65534

fecscheme FEC arrangement : Block-aligned (0) or Non Block-aligned

Type: String
Values: "Block Aligned", "Non-Block Aligned"

tpperframe Set the number of transport packets to be sent per IP packet

Type: Integer
Value: 1..7

redunmode Redundancy Mode

Type: String
Values: "Mirroring", "Backup: First Port", "Backup: Second Port", "Manual:
First Port", "Manual: Second Port"

redundir Switchover direction

Type: String
Values: "Non-Revertive" or "Revertive"

redundelfwd Delay before switching from Main to Backup port, in ms

Type: Integer
Value: 0..10000

redundelbck Delay before switching from Backup to Main port, in sec

Type: Integer
Value: 0..120

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
190
API Definitions
Output Configuration Command

Table 162: Additional arguments (preceded by ? and separated by & on command line)

Argument Description
resync Resynchronize ALL PE Output
Type: Integer
Value: 1..4
1: Resynchronize Program, PMT PID, ES list & ES PIDs
2: Resynchronize ES list
3: Resynchronize ES PIDs
4: Resynchronize Template ES List & PIDs

js 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

Note 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 by %20, for
example:
"https://192.168.0.1/ws/v2/service_cfg/output/moip?mode=Map%20Service%20Channels%20Only".

POST Examples:
Example 1: Set Various MOIP Output Parameters
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 output descrambling mode to
Descrambled and the ratemode to User.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/output/moip?dscrmode=Descrambled&ratemode=User"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
This is the same example except it is being executed on a NTC MS unit and the descrambling mode is set to
Scrambled instead of Descrambled:
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/output/moip2?dscrmode=Scrambled&ratemode=User"
GET Examples:
Example 2: Get full table of MOIP Output Settings

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
191
 API Definitions
Output Configuration Command

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 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/moip"
If successful, the return body will be (please note this is a snippet of the full return body):
"output": {
"moip": {
"mode": "No Output",
"dscrmode": "Descrambled",
"ratemode": "User",
"rate": "68.5",
"insertnul": "Yes",
"pe": [
{
"peid": "1",
"action": "Drop",
"pmtpid": "8191",
"outchan": "0"
},
{
"peid": "2",
"action": "Drop",
"pmtpid": "8191",
"outchan": "0"
}
]
}
}
This is the same example being executed on a NTC MS 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 specific unit IP in use. This example returns the specific MOIP Output setting of the
descrambled mode (dscrmode) and Output Mode (mode) parameters.

Note For GET arguments do not supply values.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/output/moip?&dscrmode&mode"
If successful, the return body will be:
"output": {
"moip": {
"dscrmode": "Descrambled",
"mode": "No Output"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
192
API Definitions
Output Configuration Command

DPM ASI/MOIP PE Output Configuration Command

Table 163: Command Details

Command Detail Description

Command URL Single-stream (NTC Basic, NTC MOIP), asi output port (only one output
exists):
https://192.168.0.1/ws/v2/service_cfg/output/asi/pe
Or alternatively,
Single-stream (NTC Basic, NTC MOIP), asi output port (only one output
exists):
https://192.168.0.1/ws/v2/service_cfg/output/asi2/pe
Single-stream (NTC Basic): MOIP is not supported.
Single-stream (NTC MOIP), only one unique moip output available:
https://192.168.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 Information Allows set or get of ASI or MOIP DPM PE output parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
193
 API Definitions
Output Configuration Command

Command Detail Description

GET Syntax Single-stream NTC MOIP or NTC Basic unit:
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi/pe"
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi2/pe"
Single-stream NTC MOIP unit:
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip/pe"
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/pe"
Multi-stream unit:
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi1/pe"
GET "https://192.168.0.1/ws/v2/service_cfg/output/asi2/pe?mode"
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/pe"
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip2/pe?mode

POST Syntax Single-stream unit:

Setting Parameters using POST "https://192.168.0.1/ws/v2/service_cfg/output/asi/pe?
command line arguments is peid=[peid#]&mode=<mode>... "
limited to maximum of 26 POST "https://192.168.0.1/ws/v2/service_cfg/output/moip/pe?
arguments after the ?. peid=[peid#]&mode=<mode>... "
Multi-stream unit:
POST "https://192.168.0.1/ws/v2/service_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>... "

URI Parameters (extension to the Command URL separated by /): N/A

Note All of the URI Arguments below apply to both GET and POST. For GET, the URI arguments do not
need any values, except the peid argument which must be supplied with 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.

Table 164: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

peid (Key) Program Entry Identifier
Type: String
XML/JSON Format Value: PE1…PE32, P1A…P16A
Command Line Input Value: 1…32 (multi-stream), 1..16
(single-stream)

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
194
API Definitions
Output Configuration Command

URI Argument Description

action PE Action
Type: String
Values: "Drop", "Pass", "Map", "XCode"

pmtpid Output PMT PID

Type: Integer
Values: 0..8191

outchan Output Channel Number

Type: Integer
Values: 0..65535

Note To use this command properly, a level 1 parameter must be specified such as asi (asi1/asi2 on a NTC MS
unit) followed by a level 2 parameter which is pe followed by the peid argument that must be supplied
with a value, and only then can the remaining arguments (as below) be used for GET/POST. In-depth
CURL examples follow below.

POST Examples:

Note All POST examples will apply to the DPM ASI PE settings, but the same examples can be applied to the
DPM MOIP PE settings, by simply replacing the ‘asi’ in the URI with ‘moip’

Example 1: Set Various DPM ASI Parameters for 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.

Note The asi/pe?peid=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 peid followed by optional
arguments).

curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/output/asi/pe?peid=1&action=Pass&outchan=105"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
195
 API Definitions
Output Configuration Command

Note All GET examples will apply to the DPM ASI PE settings, but the same examples can be applied to the
DPM MOIP PE settings, by simply replacing the ‘asi’ in the URI with ‘moip’.

Example 2: Get full table of DPM ASI Parameters for all PE’s
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 DPM ASI Output Settings for all
PE’s.
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"
If successful, the return body will be (please note this is a snippet of the full return body):
"output": {
"asi": {
"pe": [
{
"peid": "PE1",
"action": "Pass",
"pmtpid": "8191",
"outchan": "105"
},
{
"peid": "PE2",
"action": "Drop",
"pmtpid": "8191",
"outchan": "0"
},
]
}
}
Example 3: Get the table of DPM ASI Parameters for 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 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 return body will look like:
"output": {
"asi": {
"pe": {
"peid": "PE1",
"action": "Pass",
"pmtpid": "8191",
"outchan": "105"
}
}
}
Example 4: Get specific parameters of the DPM ASI Settings for 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 returns the pmtpid and output channel of the DPM
ASI Output Settings for a specific PE, in this case PE 1.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/output/asi/pe?peid=1&pmtpid&outchan"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
196
API Definitions
Output Configuration Command

If successful, the return body will look like:

"output": {
"asi": {
"pe": {
"peid": "PE1",
"outchan": "105",
"pmtpid": "8191"}
}
}

MOIP Output Stream Configuration

Table 165: Command Details

Command Detail Description

Command URL Single-stream (Basic, NTC MOIP), moip output port pair 1/2
https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo, or
https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo
Single-stream (Basic): MOIP is not supported
Multi-stream unit, moip output port pair 1/2:
https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo
Multi-stream unit, moip output port pair 3/4:
https://192.168.0.1/ws/v2/service_cfg/output/moip2/ipo

Command Information Allows set or get of MOIP Stream ID output parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax Singlestream NTC MOIP unit:

GET "https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo"
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo"
Multistream unit:
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo"
GET "https://192.168.0.1/ws/v2/service_cfg/output/moip2/ipo"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
197
 API Definitions
Output Configuration Command

Command Detail Description

POST Syntax Singlestream unit:
Setting Parameters using POST "https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo?
command line arguments is ipoid=[Stream#]&iporate=<ipo rate>... "
limited to maximum of 26 Multistream unit:
arguments after the ?.
POST "https://192.168.0.1/ws/v2/service_cfg/output/moip1/ipo?
ipoid=[Stream#]&iporate=<ipo rate>... "
POST "https://192.168.0.1/ws/v2/service_cfg/output/moip2/ipo?
ipoid=[Stream#]&iporate=<ipo rate>... "

URI Parameters (extension to the Command URL separated by /): N/A

Note All of the URI Arguments below apply to both GET and POST. For GET, the URI arguments do not
need any values, except the peid argument which must be supplied with 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.

Table 166: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

ipoid 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

iporate Bitrate (in Mbps) of Transport output stream

Type: Float
Values: 0.0…800.0

encaps Encapsulation of Transport output stream

Type: String
Values: "RTP", "UDP"

dest_ip Destination IP Address

Type: String
Values: IP address in the dot format, for example, 192.168.0.1

dest_port Destination IP Port

Type: Integer
Values: 1..65534

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
198
API Definitions
Output Configuration Command

URI Argument Description

toc Traffic Class
Type: Integer
Values: 0..255

ttl Time To Live

Type: Integer
Values: 0..255

src_port Source UDP Port

Type: Integer
Values: 0..65534
src_port = 0 means use default UDP port

ann_type Announce Type

Type: String
Values: "None", "RFC 2327"

ann_src Announce Title Source

Type: String
Values: "User String", "SDT Channel"

ann_title Announce User’s Title

Type: String
Values: Up to 32 characters

fec_mode FEC Mode

Type: String
Values: "None", "1D","2D"

fec_col Fec Columns Depth

Type: Integer
Values: 1..20

fec_row Fec Rows Depth

Type: Integer
Values: 4..20

fec_colport FEC Columns UDP Port

Type: Integer
Values: 1..65534

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
199
 API Definitions
Output Configuration Command

URI Argument Description

fec_rowport FEC Rows UDP Port
Type: Integer
Values: 1..65534

Note To use this command properly, firstly a level 1 parameter must be specified such as moip (moip1/moip2
on a NTC MS unit) followed by a level 2 parameter which is ipo followed by the ipoid argument that must
be supplied with a value, and only then can the remaining arguments (as below) be used for GET/POST.
In-depth CURL examples follow below.

POST Examples:
Example 1: Set Various MOIP Output Parameters 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 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 MOIP output bitrate to 12.5 and
Time To Live (TTL) to 54 for MOIP stream which belongs to PE4 (in SPTS) mode.

Note 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).

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/output/moip/ipo"
If successful, the return body will be (note that this is a snippet of the full return body):
"output": {
"moip": {
"ipo": [
{
"ipoid": "1",
"iporate": "68.5",
"encaps": "RTP",
"dest_ip": "225.1.1.101",
"dest_port": "49152",
"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"
},
{
"ipoid": "2",
"iporate": "18.0",
"encaps": "RTP",
"dest_ip": "168.0.169.34",
"dest_port": "49152",
"toc": "0",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
200
API Definitions
Output Configuration Command

"ttl": "34",
"src_port": "0",
"ann_type": "None",
"ann_src": "User String",
"ann_title": "Cisco Default SAP1_2",
"fec_mode": "2D",
"fec_col": "4",
"fec_row": "10",
"fec_colport": "49154",
"fec_rowport": "49156"
},
}
Example 3: Get the table of MOIP Output Stream Parameters for a specific Stream (or 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 returns the MOIP Output Settings for a specific
Stream (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/moip/ipo?ipoid=1"
If successful, the return body will be:
"output": {
"moip": {
"ipo": {
"ipoid": "1",
"iporate": "68.5",
"encaps": "RTP",
"dest_ip": "225.1.1.101",
"dest_port": "49152",
"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 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 destination IP address and the destination
IP port of the MOIP Output Settings for a specific Stream (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/moip/ipo?ipoid=1&dest_ip&dest_port"
If successful, the return body will be:
"output": {
"moip": {
"ipo": {
"ipoid": "1",
"dest_ip": "225.1.1.101",
"dest_port": "49152"
}
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
201
 API Definitions
Decode Configuration Commands

Decode Configuration Commands

This section lists the decode configuration commands.

Control Decode Configuration Command

Table 167: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/ctrl

Command Information Allows set or get of decoder enable/disable control parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/decode/ctrl", or

GET "https://192.168.0.1/ws/v2/service_cfg/decode/ctrl?decoder=[value]"

POST Syntax POST

"https://192.168.0.1/ws/v2/service_cfg/decode/ctrl?decoder=video&enable=Yes"
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

Note 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 value. In-depth CURL examples
can be seen below.

Table 168: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

decoder Decoder Identifier
Type: String
Values: "Video", "Audio1", "Audio2", "Audio3", "Audio4", "VBI",
"Data","MPE1", "MPE2", "MPE3", "MPE4", "MPE5", "STT", "DPI"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
202
API Definitions
Decode Configuration Commands

URI Argument Description

enable Enable/Disable selected Decoder
Type: String
Value: "Yes", "No"

POST Examples:
Example 1: Set a Specific Decoder to be enabled
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 sets the video decoder as enabled.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/ctrl?enable=Yes&decoder=Video"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full list of Decoders and whether they are enabled or disabled
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.
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 specific Decoder and whether it is enabled or disabled
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 the video decoder to view the
enabled status.
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?&decoder=Video"
If successful, the return body will look like:
"decode": {
"ctrl": {
"decoder": "Video",
"enable": "Yes"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
203
 API Definitions
Decode Configuration Commands

Video Decode Configuration Command

Table 169: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/video

Command Information Allows set or get of video decode settings parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/video", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/video? pvformat"

POST Syntax POST

"https://192.168.0.1/ws/v2/service_cfg/decode/video?pvformat=[value]&sdformat=[value]"
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

URI Query/Set Arguments (possible fields and values preceded by ? and separated by &):

Note 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 in the current release. It may still be accepted as an input Query/Set Argument
and shown in the output return body data in software Version 2.27 or below. The client software should
ignore and not use or display this field.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
204
API Definitions
Decode Configuration Commands

Table 170: URI Query/Set Arguments

URI Argument Description

pvformat PV Output Format
Type: String
Values: "Auto", "HD1080i", "HD720p", "SD"

sdformat SD Video Output Format

Type: String
Values: "Auto", "PAL-B/G/I/D", "PAL-M", "PAL-N (AR)", "NTSC"

POST Examples:
Example 1: Set various video 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 sets the PV Output Format to Auto and
the SD Video Output Format 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/video?sdformat=Auto&pvformat=Auto"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full Video 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 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 body (this is a snippet of the full return body):
"decode": {
"video": {
"pvformat": "Auto",
"sdformat": "Auto",
}
}
Example 3: Retrieve specific video 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. Please change
the IP to the specific unit IP in use. This example will retrieve the PV Output Format and SD Video Output
Format.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/video?&sdformat&pvformat"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
205
 API Definitions
Decode Configuration Commands

If successful, the following is an example of the return body:

"decode": {
"video": {
"pvformat": "Auto",
"sdformat": "Auto"
}

Aspect Ratio (AR) Decode Configuration Command

Table 171: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/ar

Command Information Allows set or get of aspect ratio decode settings parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/ar", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/ar?sdar"

POST Syntax POST

"https://192.168.0.1/ws/v2/service_cfg/decode/ar?sdar=[value]&arselect=[value]"
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

Note 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

Table 172: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

sdar Standard Definition Aspect Ratio
Type : String
Value: "4:3", "16:9"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
206
API Definitions
Decode Configuration Commands

URI Argument Description

arselect Selected Aspect Ratio Conversion
Type: String
Value: "None", "Auto", "Auto AFD", "16:9 L/B", "4:3 P/B", "14:9",
"4:3 CCO", "16:9 SCALE"

wssmode Wide Screen Signaling Mode

Type: String
Values: "Passthrough", "Suppress", "Auto:Modify", "Auto:Create"

POST Examples:
Example 1: Set various Aspect Ratio 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 sets the Standard Definition Aspect Ratio
to 4:3 and the Selected Aspect Ratio Conversion 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/ar?arselect=Auto&sdar=4:3"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full Aspect Ratio 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 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 like (this is a snippet of the full return body):
"decode": {
"ar": {
"sdar": "4:3",
"arselect": "Auto",
"wssmode": "Passthrough"
}
}
Example 3: Retrieve specific Aspect Ratio 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 use. The following example retrieves the Standard Definition Aspect
Ratio and the Selected Aspect Ratio Conversion.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/ar?&arselect&sdar"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
207
 API Definitions
Decode Configuration Commands

If successful, the return body will look like:

"decode": {
"ar": {
"arselect": "Auto",
"sdar": "4:3"
}
}

Subtitle (SUBT) Decode Configuration Command

Table 173: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/subt

Command Information Allows set or get of subtitle decode settings parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/subt", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/subt?opmode"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/decode/ar?opmode=[value]"

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

Note 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

Table 174: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

opmode Operational Mode of Subtitle
Type: String
Value: "Off", "On", "Imitext", "DVB"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
208
API Definitions
Decode Configuration Commands

URI Argument Description

langmenu Language Menu Options
Type: String
Value: "Language List", "Language Entry", "PMT Order"

langentry Language Entry

Type: String
Value: 3 character language string

pmtorder PMT Order of Subtitle PID

Type: String
Values: "First", "Second", "Third", "Fourth", "Fifth", "Sixth",
"Seventh", "Eighth"

imitext imitext Position

Type: String
Values: "Standard", "Extended"

foregndcol Foreground Color

Type: String
Values: "Auto", "Yellow", "White"

backgndcol Foreground Color

Type: String
Values: "None", "Auto", "Shadow", "Opaque", "Semi"

POST Examples:
Example 1: Set various Subtitle 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. 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
"https://192.168.0.1/ws/v2/service_cfg/decode/subt?imitext=Standard&foregndcol=Auto"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full Subtitle Settings

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
209
 API Definitions
Decode Configuration Commands

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.
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"
If successful, the return body will look:
"decode": {
"subt": {
"opmode": "Off",
"langmenu": "Language Entry",
"langlist": "eng",
"langentry": "eng",
"pmtorder": "First",
"imitext": "Standard",
"foregndcol": "Auto",
"backgndcol": "Auto"
}
}
Example 3: Retrieve specific Subtitle 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 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 Configuration Command

Table 175: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/cc

Command Information Allows set or get of closed caption decode settings parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/cc", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/cc?prefccmode"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
210
API Definitions
Decode Configuration Commands

Command Detail Description

POST Syntax POST
"https://192.168.0.1/ws/v2/service_cfg/decode/cc?prefccmode=[value]"
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

Note For POST, the value for the argument seen below must be specified, but for GET there are no values
for arguments.

Table 176: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

prefccmode Preferred Closed Caption Mode
Type: String
Value: "Auto", "SA Custom", "EIA 708”, "Type 3", "DirectTv Type 3",
"Type 4 SA", "Type 4 ATSC", "Reserved", "DVS 157"

POST Examples:
Example 1: Set various CC 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. 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:
Example 2: Retrieve the full CC 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 use.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/cc"
If successful, the return body will look like:
"decode": {
"cc": {
"prefccmode": "Auto"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
211
 API Definitions
Decode Configuration Commands

Note The full CC settings table is the same as just retrieving it with the prefccmode argument as the prefccmode
argument is the only argument of CC.

Audio Decode Configuration Command

Note The audio decode configuration command is only supported in Version 1.x to 2.05.

Table 177: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/audio

Command Information Allows set or get of audio decode settings parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax One of the following:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/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"
Note This option is available in Version 2.75 or
later.
This command format is currently equivalent to specifying the GET
operation for service_cfg/device/audio without any Query arguments. It
will return the complete data for all Audio device instances. Other filter
parameters will currently be ignored when specified along with the GET
device=all key for this command.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
212
API Definitions
Decode Configuration Commands

Command Detail Description

POST Syntax POST
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?device=[device#]
Setting Parameters using
command line arguments is &mode=[value]&…", or
limited to maximum of 26
POST "https://192.168.0.1/ws/v2/service_cfg/decode/audio?
arguments after the ?.
device=all&langmenu=Language%20List"
Note This option is available in Version 2.75 or
later.
Unlike the device=[device#] format, this command variation allows
values of specific fields to be set simultaneously for all of the available
Audio device instances.

URI Parameters (extension to the Command URL separated by /): N/A

The following table lists the URI arguments:
Note All of the URI Arguments below apply 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.

Table 178: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

device (key) Audio Device Instance
Type: Integer
Value: 1 .. 2, all

mode Audio Mode

Type: String
Value: "Stereo", "Mixed", "L-MONO", "R-MONO"

ac3comp AC3 Compression

Type: String
Value: "RF Mode", "Line Mode", "Custom 1", "Custom 0"

left Left volume

Type : Float
Value: -6.0 .. 6.0

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
213
 API Definitions
Decode Configuration Commands

URI Argument Description

Right right volume
Type : Float
Value: -6.0 .. 6.0

pmtsrc PMT Audio Source

Type: String
Value: "AUD1", "AUD2", ……. "AUD64"

ddpmode Dolby Digital Mode

Type: String
Value: "Trans", "Pass"

langmenu Language Selection Menu option

Type: String
Value: "Language List", "Language Entry", "PMT Order"

lang Language Value.

Type: String
Value: Any valid 3 character language code, for example, "eng"

POST Examples:
Example 1: Set various Audio 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. This example sets the ddpmode to Pass.

Note The device index must be specified in the URI. For this example the ddpmode will be set for audio device
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?ddpmode=Pass&device=1"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full Audio Settings for a specific device

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
214
API Definitions
Decode Configuration Commands

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. In this example the audio settings are retrieved for Device 1.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?right&left&ddpmode&mode&device=1&
lang&ac3comp&pmtsrc&langmenu"
If successful, the return body will be:
"decode": {
"audio": {
"device": "1",
"ac3comp": "RF Mode",
"ddpmode": "Pass",
"lang": "eng",
"langmenu": "PMT Order",
"left": "0.0",
"mode": "Stereo",
"pmtsrc": "AUD1",
"right": "0.0"
}
}
Specific audio setting arguments per given audio device can be retrieved by including the specific argument
in the URI. For example, to only retrieve the pmtscr and langmenu arguments of audio device 1, the CURL
command is:
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?device=1&pmtsrc&langmenu"
Example 3: Set Audio decoder langmenu option to all Audio devices
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 sets the langmenu option to PMT%20Order.

Note The device=all must be specified in the URI for PMT%20Order case because that setting value cannot be
combined with any other "Language%20List" or "Language%20Entry" option value for other devices.

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=all&langmenu=PMT%20Order"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 4: Set Audio decoder langmenu option to Language List when previously set to PMT Order
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 is intended to be run only after Example 3 and sets the langmenu option to Language%20List.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
215
 API Definitions
Decode Configuration Commands

Note The device=all must be specified in the URI for Language%20List case when the existing value was
previously set to PMT%20Order because that setting value cannot be combined with any other
"Language%20List" or "Language%20Entry" option value for other devices.

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=all&langmenu=Language%20Lis
t"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 5: Attempt to set Audio decoder langmenu option to PMT Order using device=# instead of
device=all format
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 is intended to be run only after Example 4 and attempts to sets the langmenu option to
PMT%20Order on only one device.

Note The device=all must be specified in the URI for PMT%20Order case because that setting value cannot be
combined with any other "Language%20List" or "Language%20Entry" option value for other devices.

This example is not expected to be 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 value for all devices first as per Example 3.
Example 6: Attempt to set Audio decoder langmenu option to Language Entry using device=# instead
of device=all format after all Audio devices already have langmenu set to PMT Order
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 is intended to be run only after Example 3 and attempts to sets the langmenu option
to Language%20Entry on only one device.

Note The device=all must be specified in the URI for Language%20Entry case when the existing value was
previously set to PMT%20Order because that setting value cannot be combined with any other
"Language%20List" or "Language%20Entry" option value for other devices.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
216
API Definitions
Decode Configuration Commands

The following example is not expected to be 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=2&langmenu=Language%20Entry"
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 value for all devices first as per below:
This example sets the langmenu option for ALL Audio devices to Language%20Entry.

Note The device=all must be specified in the URI for Language%20Entry case when the existing value was
previously set to PMT%20Order because that setting value cannot be combined with any other
"Language%20List" or "Language%20Entry" option value for other devices.

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=all&langmenu=Language%20Ent
ry"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
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 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 is intended to be run only after either all or some of current Audio devices are already set to
using either Language%20Entry or Language%20List but not PMT%20Order. We recommend that you first
set all the devices (using the "device=all" POST version of the command) to the same Language%20xxxx
option value before changing the setting for individual devices.
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=2&langmenu=Language%20Entry"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
217
 API Definitions
Decode Configuration Commands

Audio Device SDI Preference Setting Command

Note The audio decode configuration command is only supported in Version 2.26 and later.

Table 179: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/audio (for SDI Audio
Preference Setting)

Command Information Allows set or get of audio decode SDI preference setting parameter.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/decode/audio?

device=[device#]&sdiindex=[sdiindex#]&sdipref"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/decode/audio?

Setting Parameters using device=[device#]&sdiindex=[sdiindex#]&sdipref=[sdiprefvalue]…"
command line arguments is
limited to maximum of 26
arguments after the ?.

URI Parameters (extension to the Command URL separated by /): N/A

[1]:
Note 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 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.

Table 180: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

device (key) Audio Device Instance
Type: Integer
Value: 1 .. 2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
218
API Definitions
Decode Configuration Commands

URI Argument Description

sdiindex (key) Audio SDI Device Instance
Type: Integer
Value: 1
Note For this command, the only valid value for sdiindex is
1. This is not to be confused with the sdiindex value
(1..2) range that applies for other commands (such as
ws/v2/service_cfg/decode/sdiaudio).
sdipref SDI Audio Preference/AES Output Control
Type: String
Values: "CM Samples", "Compressed"

POST Examples:
Example 1: Set Audio Device SDI Preference
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 sets the sdipref to Compressed. Please note that the
device index must be specified in the URI as well as the sdiindex. For this example the sdipref will be set for
audio device 1 and sdiindex 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, 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. In this example the audio device is 1 and sdiindex is 1. Please note
that the only argument of this command is sdipref hence it must be part of the URI.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?device=1&sdiindex=1&sdipref"
If successful, the return body will look like:
"decode": {
"audio": {
"sdipref": "Compressed"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
219
 API Definitions
Decode Configuration Commands

Audio Device SDI1 or SDI2 Output Settings Command

Table 181: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/audio (for SDI1 or SDI2
Output Settings)

Command Information Allows set or get of audio decode SDI1 or SDI2 output settings
parameter.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v2/service_cfg/decode/audio? sdi1output"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/decode/audio?

Setting parameters using sdi1output=[sdi1_stringvalue]…"
command line arguments is
limited to maximum of 26
arguments after the ?.

URI Parameters (extension to the Command URL separated by /): N/A

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

Table 182: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

Sdi1output SDI1 Output Mode
Type: String
Value: "PVO", "SD"

Sdi2output SDI2 Output Mode

Type: String
Value: "PVO", "SD"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
220
API Definitions
Decode Configuration Commands

As seen above, the possible URIs are seen. The SDI 1 and 2 Output Modes are still a part of audio. Place the
specific URI (see above) into the CURL command and the user will be able to POST and GET the SDI 1 and
2 Output Modes.
POST Example
Example 1: Set Audio Device SDI1Output:
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?sdi1output=PVO"
If successful, the return body will look like:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Example
Example 2: Retrieve the Audio Device SDI1Output setting
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?sdi1output"
If successful, the return body will look like:
"decode": {
"audio": {
"sdi1output": "PVO"
}
}

Audio ST302 Device Settings Command

Table 183: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/aud_302

Command Information Allows set or get of audio ST302 decoder settings.

HTTP Method(s) GET, POST

Access Type Read, Write

Access Level User, Admin

Syntax GET "https://192.168.0.1/ws/v2/service_cfg/decode/aud_st302

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/decode/aud_st302?

Setting Parameters using command line streamid=2”
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 &):

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
221
 API Definitions
Decode Configuration Commands

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

Table 184: URI Query/Set Arguments

URI Argument Description

device ST302 Device ID
Type: String
Value: "1"
streamid ST302 Stream ID
Type: String
Value: "1", "2", "3", "4"

POST Example
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/ws/v2/service_cfg/decode/aud_302"
If successful, the return body will look like:
"decode": {
"aud_st302": {
"device": "1",
"streamid": "2"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
222
API Definitions
Decode Configuration Commands

SDI Decode Configuration Command

Table 185: Command Details

Command Detail Description

Command URL SDI Audio:
https://192.168.0.1/ws/v2/service_cfg/decode/sdiaudio
SDI VANC:
https://192.168.0.1/ws/v2/service_cfg/decode/sdivanc
SDI VII:
https://192.168.0.1/ws/v2/service_cfg/decode/sdivii
Command Information Allows set or get of decode settings for SDI parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax SDI Audio:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdiaudio", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdiaudio?
group=1&slot=1&sdiindex=1&decoder"
SDI VANC (Vertical Ancillary Data):
GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivanc", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivanc?
serviceid=AFD&sdiindex=1&enable"
SDI VII:
GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivii", or
GET "https://192.168.0.1/ws/v2/service_cfg/decode/sdivii? sdiindex=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
223
 API Definitions
Decode Configuration Commands

Command Detail Description

POST Syntax SDI Audio:
Setting parameters using POST
command line arguments is "https://192.168.0.1/ws/v2/service_cfg/decode/audio?group=1&slot=1/2&
limited to maximum of 26 sdiindex=1&decoder=PCM%20%Audio%201&chan=Left/Right"
arguments after the ?.
SDI VANC (Vertical Ancillary Data):
POST
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?serviceid=AFD&enable=Yes"
SDI VII:
POST
"https://192.168.0.1/ws/v2/service_cfg/decode/audio?sdiindex=1&enable=Enabled"

URI Parameters (extension to the Command URL separated by /): N/A

Note All of the URI Arguments below apply to both GET and POST except where indicated. For GET,
the URI arguments 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 Arguments.

Table 186: SDIAUDIO URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

group (key) Audio Group
Type: Integer
Value: 1..4

slot (key) Group Slot

Type: Integer
Value: 1/2, 3/4

sdiindex (key) Audio SDI Device Instance

Type: Integer
Value: 1..2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
224
API Definitions
Decode Configuration Commands

URI Argument Description

decoder Audio Decoder
Type: Integer
Values: "PCM Audio 1", "PCM Audio 2", "PCM Audio 3", "PCM Audio 4",
"Compressed Audio 1", "Compressed Audio 2", "Compressed Audio 3",
"Compressed Audio 4", "Off" or exist (for GET output filtering)
Type: Integer
Value: 1..4

chan Audio Channel

Type: String
Value: "Left/Right" or "Right/Left", or exist (for GET output filtering)

Table 187: SDIVANC URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

SDI VANC URI Argument Description

serviceid (key) VANC Service Identifier
Type: String
Value: "EIA-708", "AFD", "DPI", "SMPTE-2031", "SDP-OP47",
"MULTI-OP47"

sdiindex (key) Audio SDI Device Instance

Type: Integer
Value: 1..2

enable Enable or Disable VANC Service

Type: String
Value: "Yes", "No", or exist (for GET output filtering)

maxoffset Maximum Line Offset Allowed

Type: Integer
Value: 2..18, or exist (for GET output filtering)

Table 188: SDIVII URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

SDI VII Argument Description

sdiindex (key) VII SDI Device Instance
Type: Integer
Value: 1..2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
225
 API Definitions
Decode Configuration Commands

SDI VII Argument Description

enable Specify for POST operation only
Enable or Disable VII Service
Type: String
Value: "Enabled", "Disabled"

Note The possible URI for both POST and GET for sdivanc, sdiaudio, and sdivii are seen above. Please place
these URIs into the CURL command with a valid token and users will be able to POST and GET. Refer
to the POST and GET syntax examples in the Command Details section above for examples on how to
do GET and POST with CURL commands.

HDMI Decode Configuration Command

Table 189: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/hdmi

Command Information Allows set or get of decode settings for HDMI parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax 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"

POST Syntax Single HDMI Video setting:

Setting parameters using POST "https://192.168.0.1/ws/v2/service_cfg/decode/hdmi?
command line arguments is hdmiindex=1&colorspace=YCbCr420"
limited to maximum of 26 Multiple HDMI Video settings:
arguments after the ?.
POST "https://192.168.0.1/ws/v2/service_cfg/decode/hdmi?
hdmiindex=1&colorspace=YCbCr422&colorrange=Full&eotf=HDR"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
226
API Definitions
Decode Configuration Commands

URI Parameters (extension to the Command URL separated by /): N/A

Note All of the URI Arguments below apply to both GET and POST. For GET, the URI arguments do not
need any values, except ‘hdmiindex’ which must be specified. For POST ‘hdmiindex’ must be specified
followed by any of the below 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.

Table 190: HDMI URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

hdmiindex (key) HDMI Device Instance
Type: Integer
Value: 1..2

colorspace HDMI Color Space

Type: String
Value: "Auto", "YCbCr420", "YCbCr444", "YCbCr422", "RGB"

colordepth HDMI Color Depth

Type: String
Value: "Auto", "16bit", "12bit", "10bit", "8bit"

colorrange HDMI Color Range

Type: String
Value: "Auto", "Full", "Limited"

matrixcoeff HDMI Matrix Coefficients

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

Eotf HDMI EOTF (Electro-Optical Transfer Function)

Type: String
Value: "Auto", "SMPTE-2084", "HDR", “SDR”

displaypref HDMI Display Preference

Type: String
Value: "Auto", "SDI1", "SDI2", "HDMI"

forceedid HDMI Force EDID selector

Type: String
Value: "Yes", "No"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
227
 API Definitions
Decode Configuration Commands

Advanced Audio Decode Configuration Command

Table 191: Command Details

Command Detail Description

Command URL Advanced Audio On/Off Control:
https://192.168.0.1/ws/v2/service_cfg/decode/advaudio_control
Advance Audio Settings: HDMI:
https://192.168.0.1/ws/v2/service_cfg/decode/advaudio_hdmi
Advanced Audio Settings: SDI:
https://192.168.0.1/ws/v2/service_cfg/decode/advaudio_sdi

Command Information Allows set or get of decode settings for advanced audio parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax Advanced Audio Control

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://192.168.0.1/ws/v2/service_cfg/decode/advaudio_sdi"
Audio Setting for specified SDI instance/group/slot:
GET "https://192.168.0.1/ws/v2/service_cfg/decode/
advaudio_sdi?sdiindex=1&group=1&slot=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
228
API Definitions
Decode Configuration Commands

Command Detail Description

POST Syntax Advanced Audio Control
Setting parameters using POST "https://192.168.0.1/ws/v2/service_cfg/decode/
command line arguments is advaudio_control?enable=Yes"
limited to maximum of 26
HDMI Advanced Audio Settings
arguments after the ?.
POST "https://192.168.0.1/ws/v2/service_cfg/decode/
advaudio_hdmi?hdmiindex=1&pair=1&slot=1&decoder=2&
chan=Downmix%20Right"
SDI Advanced Audio Settings
POST "https://192.168.0.1/ws/v2/service_cfg/decode/
advaudio_sdi?sdiindex=1&group=1&slot=1&
input=PCM%20Pair%201&chan=Right/Left"

URI Parameters (extension to the Command URL separated by /): N/A

Note All of the URI Arguments listed for HDMI Settings apply to both GET and POST. For GET, the
URI arguments 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.

Table 192: Advanced Audio Control URI Query/Set Arguments (possible fields and values preceded by ? and separated
by &)

Advanced Audio Control URI Argument Description

enable Advanced Audio Control
Type: String
Value: "Yes", "No"

Table 193: HDMI Settings URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

HDMI Settings URI Argument Description

hdmiindex (key) HDMI Device Instance
Type: Integer
Value: 1..2

pair (key) PCM Pair

Type: Integer
Value: 1..4

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
229
 API Definitions
Decode Configuration Commands

HDMI Settings URI Argument Description

slot (key) PCM Pair Slot
Type: String
Value: "Left", "Right"

decoder Audio Decoder

Type: String
Value: "1", "2", "3", "4", "Off"

chan Audio Channel

Type: String
Value: "Downmix Left" or "Downmix Right"
Note The space character must be replaced with ‘%20’ in POST
command.

Note All of the URI Arguments listed for VBI Settings apply to both GET and POST. For GET, the URI
arguments do not need any values. For POST the arguments in the following table need to be set
with a value. The GET result output field names re-use the argument names and possible values.

Table 194: SDI Settings URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

SDI Settings URI Argument Description

sdiindex (key) Audio SDI Device Instance
Type: Integer
Value: 1..2

group (key) Audio Group

Type: Integer
Value: 1..4

slot (key) Group Slot

Type: String
Value: "1/2" or "3/4"

input Audio Input

Type: String
Value: "PCM Pair 1", "PCM Pair 2", "PCM Pair 3", "PCM Pair
4", "Compressed Audio 1", "Compressed Audio 2",
"Compressed Audio 3", "Compressed Audio 4", "Off"
Note The space character must be replaced with ‘%20’ in
POST command.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
230
API Definitions
Decode Configuration Commands

SDI Settings URI Argument Description

chan Audio Channel Order
Type: String
Value: "Left/Right" or "Right/Left"

VBI Configuration Command

Table 195: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/decode/vbi

Command Information Allows set or get of decode settings for VBI parameters.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All VBI Settings:

GET "https://192.168.0.1/ws/v2/service_cfg/decode/hdmi? hdmiindex=1"
Single VBI Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/decode/vbi? vitspal17"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/decode/vbi?

wstlnstart=Standard&vitspal17=Disable"
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 fields and values preceded by ? and separated by &)

URI Argument Description

wstinstart WST Line Start
Type: String
Value: "Standard", "Early"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
231
 API Definitions
Decode Configuration Commands

URI Argument Description

vitspal17 Enable VITS PAL Line 17
Type: String
Value: "Enable", "Disable"

vitspal18 Enable VITS PAL Line 18

Type: String
Value: "Enable", "Disable"

vitspal330 Enable VITS PAL Line 330

Type: String
Value: "Enable", "Disable"

vitspal331 Enable VITS PAL Line 331

Type: String
Value: "Enable", "Disable"

vitcmode VITC Mode

Type: String
Value: "Passthrough", "Suppress", ”Auto:Modify”, “Auto:Create”

vitctmcode VITC Time Code

Type: String
Value: "LTC", "VITC", "BOTH"

vitcdropfr Enable VITC Drop Frame

Type: String
Value: "Disable", "Enable"

POST Examples:
Example 1: Set various VBI 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-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/decode/vbi?vitcdropfr=Enable&vitcmode=Suppress"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
232
 API Definitions
CA (Conditonal Access) Configuration Commands

GET Examples:
Example 2: Retrieve the full VBI 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 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/vbi"
If successful, the following is an example of the return body:
"decode": {
"vbi": {
"wstinstart": "Standard",
"vitspal17": "Disable",
"vitspal18": "Disable",
"vitspal330": "Disable",
"vitspal331": "Disable",
"vitcmode": "Passthrough",
"vitctmcode": "LTC",
"vitcdropfr": "Enable"
}
}
Example 3: Retrieve specific VBI 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 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 of the return body:
"decode": {
"vbi": {
"vitcdropfr": "Enable"
}
}

CA (Conditonal Access) Configuration Commands

This section lists the conditional access configuration commands.

PowerVu (PVU) CA Configuration Command

Table 197: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/ca/pvu

Command Information Allows set or get of PowerVu Conditonal Access configuration.

HTTP Methods GET, POST

Access Type Read, Write

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
233
 API Definitions
CA (Conditonal Access) Configuration Commands

Command Detail Description

Access Level User, Admin

GET Syntax All PVU Settings:

GET "https://192.168.0.1/ws/v2/service_cfg/ca/pvu"
Single PVU Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/pvu/camode"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/ca/pvu?camode=Std"

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

Note For POST, the value for the argument seen below must be specified, but for GET there are no values
for arguments.

Table 198: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

port (Key) Type: Integer
Applies to multi-stream units only. Values: 1 .. 16 (NFE), 1 .. 2 (ASI), 1 (MOIP)

stream (Key) Multi Input Stream ID. If not specified, default value
of 1 is used.
(optional)
Type: Integer
Applies to multi-stream units only.
Values: 1..6 (RF), 1 (ASI), 1..32 (MOIP)

camode PowerVu Conditional Access Mode

Type: String
Value: "Std", "Open"

POST Examples:
Example 1: Set various PowerVu CA 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 sets the commode to Std.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/ca/pvu?&camode=Std"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
234
API Definitions
CA (Conditonal Access) Configuration Commands

If successful, the following is an example of the return body:

"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the full PowerVu CA 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 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/pvu"
If successful, the following is an example of the return body:
"ca": {
"pvu": {
"camode": "Std"
}
}

Note Running with the specific camode argument will return the same response as above, as PowerVu CA only
has one argument.

BISS CA Configuration Command

Table 199: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/ca/biss

Command Information Allows set or get of BISS Conditional Access configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All BISS Settings:

GET "https://192.168.0.1/ws/v2/service_cfg/ca/biss"
Single BISS Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/biss?bissmode"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
235
 API Definitions
CA (Conditonal Access) Configuration Commands

Command Detail Description

POST Syntax POST “https://192.168.0.1/ws/v2/service_cfg/ca/biss?
Setting parameters using bissmode=Mode%201"
command line arguments is
limited to maximum of 26
arguments after the ?.

URI Parameters (extension to the Command URL separated by /): N/A

Note For POST, the value for the argument seen below must be specified, but for GET there are no values
for arguments. Also, the write only commands that can be used for POST are noted below.

Table 200: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

port (Key) Input port to be configured.
Applies to multi-stream units only. Type: Integer
Values: 1 .. 16 (NFE), 1 .. 2 (ASI), 2 (MOIP)

stream (Key) Multi Input Stream ID. If not specified, default value of 1 is used.
(optional) Type: Integer
Applies to multi-stream units only. Values: 1..6 (RF), 2 (ASI), 1..32 (MOIP)

bissmode BISS Mode of operation

Type: String
Value: "Mode 1", "Mode E"

mod1seswrd Mode-1 Session Word

(Write Only) Type: String
Value: String with 12 characters

modeseswrd Mode-E Encrypted Session Word

(Write Only) Type: String
Value: String with 16 characters

modeinjid Mode-e Injected ID

(Write Only) Type: String
Value: String with 14 characters

POST Examples:
Example 1: Set various BISS Setting Arguments

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
236
API Definitions
CA (Conditonal Access) Configuration Commands

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 set the bissmode to Mode 1.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/ca/biss?&bissmode=Mode%201"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 2: Retrieve the PowerVu CA 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 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": "**************"
}
}

Note The mod1seswrd, modeseswrd, and modeinjid are write-only, so their values will not be shown when
trying to perform GET. Hence, only the bissmode will provide useful information from a BISS GET.

CI (Common Interface) Configuration Command

Table 201: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/ca/ci

Command Information Allows set or get of Common Interface (CI) Conditional Access
configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
237
 API Definitions
CA (Conditonal Access) Configuration Commands

Command Detail Description

GET Syntax All CI CAM Settings:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/ci"
Single CI CAM Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/ci?sengdquery"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/ca/ci? sendquery=Enable"

Setting parameters using
command line arguments is
limited to maximum of 26
arguments after the ?.

Note These arguments are intended to be used with POST. When this command is used as a GET command
these arguments generally serve as output field descriptions

Table 202: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

sendquery Send Query to CAM before enabling descrambling
Type: String
Value: "Enable", "Disable"

autoreset Auto Reset CAM on failure

Type: String
Value: "Enable", "Disable"

listmgmt CA PMT List management mechanism

Type: String
Value: AddDel, UpdateAll

tsonetchk Transport ID/ Original Network ID check

Type: String
Value: "Enable", "Disable"

tsid Transport ID
Type: Integer
Value: 0..65535

onetid Original Network Identifier

Type: Integer
Value: 0..65535

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
238
API Definitions
CA (Conditonal Access) Configuration Commands

URI Argument Description

tsrouting Transport Routing
Type: String
Value: "EntireTS", "ServicesOnly"

POST Examples:
Example 1: Set various CI 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 disables autoreset and sets tsid to 100.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/ca/ci?autoreset=Disable&tsid=100"
GET Examples:
Example 2: Retrieve the CI 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 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": "Disable",
"listmgmt": "AddDel",
"tsonetchk": "Disable",
"tsid": "0",
"onetid": "0",
"tsrouting": "ServicesOnly"
}
}
}

PE CA Configuration Command
Table 203: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/ca/pe

Command Information Allows set or get of Conditional Access Program Entry (PE)
configuration.

HTTP Methods GET, POST

Access Type Read, Write

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
239
 API Definitions
CA (Conditonal Access) Configuration Commands

Command Detail Description

Access Level User, Admin

GET Syntax All PE CA Settings:

GET "https://192.168.0.1/ws/v2/service_cfg/ca/pe"
Single PE CA Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/pe? peid=1&cidecrypt

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/pe? peid=1&cidecrypt=ON"

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

Note These arguments are intended to be used with POST. When this command is used as a GET command
these arguments generally serve as output field descriptions.

Table 204: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

peid Program Entry ID
Type: Integer
Value: 1..32

cidecrypt Program CAM Decrypt Mode

Type: String
Value: "OFF", "ON", "Comp"

cipe1slot CAM Slot for Program Entry 1

Type: String
Value: "TOP", "BOTTOM", "AUTO"

cislot CAM Slot for Program Entries other the PE1

Type: String
Value: "TOP", "BOTTOM"

POST Examples:
Example 1: Set various PE Setting Arguments

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
240
API Definitions
CA (Conditonal Access) Configuration Commands

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 sets Program Entry ID 1 to ON.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/ca/pe?peid=1&cidecrypt=ON"
GET Examples:
Example 2: Retrieve the PE 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 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 Command

Table 205: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/ca/cicomp

Command Information Allows set or get of Conditional Access CI Component level

configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
241
 API Definitions
CA (Conditonal Access) Configuration Commands

Command Detail Description

GET Syntax All CICOMP CA Settings:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/cicomp"
Single CICOMP CA Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/ca/cicomp?
peid=1&cidecrypt"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/ca/cicomp?

idx=5&peid=1&cidecrypt=ON&oper=Add"
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

Note These arguments are intended to be used with POST. When this command is used as a GET command
these arguments generally serve as output field descriptions

Table 206: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

idx (Key) Index of Row in UIC Table
Mandatory for POST command Type: Integer
Value: 1..64

peid Program Entry ID

Type: Integer
Value: 1..32

mode CI Component Mode

Type: String
Value: "PID", "STREAM"

pid CI Component PID

Type: Integer
Value: 0..8192

strmcat Stream Category

Type: String
Value: "VID", "AUD", "SUBT", "TTX", "USER"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
242
API Definitions
CA (Conditonal Access) Configuration Commands

URI Argument Description

strmval User Stream Type Value
Type: Integer
Value: 0..255

strminst User Stream Instance

Type: Integer
Value: 1..64

oper Component operation

Type: String
Value: "Add", "Delete", "Edit"

GET Examples:
Example 1: Retrieve all the CICOMP 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 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"
}
]
}
}
POST Examples:

Note POST requires previous knowledge of target row (idx – key) from GET command.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
243
 API Definitions
Transcoding Configuration Commands

Example 2: Set various CICOMP 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 sets the mode for program entry 1 to
STREAM.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID:$token" -k
"https://192.168.0.1/ws/v2/service_cfg/ca/cicomp?idx=5&peid=1&mode=STREAM"
Expected response if CA card is not installed in NCI slot:
{
"response": {
"code": "10",
"result": "failure",
"message": "CI Validation Failed - NCI Required"
}
}
Expected response if CA card is installed in NCI slot:
{
"response": {
"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=5:
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?idx=5"
If successful, the return body will look like:
{
"ca": {
"cicomp": {
"idx": "5",
"peid": "1",
"mode": "STREAM",
"pid": "8192",
"strmcat": "USER",
"strmval": "0",
"strminst": "1",
"oper": "Inactive"
}
}
}

Transcoding Configuration Commands

This section lists the transcoding configuration commands.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
244
API Definitions
Transcoding Configuration Commands

HD Transcode Configuration Command

Table 207: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/transcode/hd

Command Information Allows set or get of HD transcode configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All HD transcode Settings:

GET "https://192.168.0.1/ws/v2/service_cfg/transcode/hd"
Single HD transcode Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/transcode/hd?vres"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/transcode/hd? vres=Auto"

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

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

Table 208: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

index (Key) Transcoder to be configured
Type: Integer
Values: 1..N (number of transcoders depends on model and installed
options)

vres Select the video format of the transcoded output

Type: String
Values: "Auto", "HD Output", "SD Output"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
245
 API Definitions
Transcoding Configuration Commands

URI Argument Description

hres Select the output horizontal resolution for HD video output
Type: String
Values: "Full", "3/4"

bitratemode Select whether the output bit rate is constant or variable for HD video
output
Type: String
Values: "CBR", "VBR"

bitrate Select the output bit rate for HD output video

Type: Float
Values: 10.0..25.0

gop Select whether to manually select the Group of Pictures settings

Type: String
Values: "I Frame Sync", "User GOP(MN)"

usergop If the HD GOP Control is under User GOP, select the M and N values
Type: String
Values: "1 0", "12 2", "15 2", "24 2", "30 2"

pulldown32 Select whether 3:2 pulldown is enabled or not

Type: String
Values: "Disabled", "Enabled"

POST Examples:
Example 1: Changing one HD 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. 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/hd?index=5&bitratemode=CBR"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple HD Transcoding Parameters
The following example assumes that the user has successfully logged onto the unit, received the session id
and set it to the variable token. In addition, it is assumed that the IP of the unit is 192.168.0.1. You must

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
246
API Definitions
Transcoding Configuration Commands

change the IP to the specific unit IP in use. The following example changes several HD transcoder 5 parameters.
It will set the bitratemode to CBR, bitrate to 18, and pulldown32 to Disabled.
curl -X POST -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=CBR&bitrate=18&pulldown32=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 HD 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. You must
change the IP to the specific unit IP in use. The following example retrieves all of the HD transcoder settings
for transcoder 5.

Note The user must specify the index in the URI.

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"
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 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 one specific parameter value
from the ASI tuning settings for ASI port 1.

Note The user must specify the port number in the URI followed by the URI argument the user wishes to retrieve.
This example retrieves the bitrate 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.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/transcode/hd?index=5&bitrate"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
247
 API Definitions
Transcoding Configuration Commands

If successful, the following example is the return body:

"transcode": {
"hd": {
"index": "5",
"bitrate": "16.0"
}
}
Example 5: GET multiple HD 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. 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.

Note The user must specify the port number in the URI followed by the URI arguments the user wishes to
retrieve. This example retrieves the bitratemode, bitrate and 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.

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",
"bitrate": "16.0",
"bitratemode": "CBR",
"pulldown32": "Disabled"
}
}

SD Transcode Configuration Command

Table 209: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/transcode/sd

Command Information Allows set or get of SD transcode configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
248
API Definitions
Transcoding Configuration Commands

Command Detail Description

GET Syntax All SD transcode Settings:
GET "https://192.168.0.1/ws/v2/service_cfg/transcode/sd"
Single SD transcode Setting:
GET "https://192.168.0.1/ws/v2/service_cfg/transcode/sd?vres"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/transcode/sd? vres=Auto"

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

Note 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 in the following table.

Table 210: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

index (Key) Transcoder to be configured
Type: Integer
Values: 1..N (number of transcoders depends on model and installed
options)

vres Select the video format of the transcoded output

Type: String
Values: "Auto", "HD Output", "SD Output"

hres Select the output horizontal resolution for HD video output

Type: String
Values: "Full", "3/4"

bitratemode Select whether the output bit rate is constant or variable for HD video
output
Type: String
Values: "CBR", "VBR"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
249
 API Definitions
Transcoding Configuration Commands

URI Argument Description

bitrate Select the output bit rate for HD output video
Type: Float
Values: 10.0..25.0

gop Select whether to manually select the Group of Pictures settings

Type: String
Values: "I Frame Sync", "User GOP(MN)"

usergop If the HD GOP Control is under User GOP, select the M and N values
Type: String
Values: "1 0", "12 2", "15 2", "24 2", "30 2"

pulldown32 Select whether 3:2 pulldown is enabled or not

Type: String
Values: "Disabled", "Enabled"

aspectratio Select the aspect ratio of the SD video output

Type: String
Values: "4:3", "16:9"

aspectconv 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"

ccpkt1 Select which content to place in the first Closed Captioning Packet
for SD video output
Type: String
Values: "None", "CEA 708", "SCTE-20"

ccpkt2 Select which content to place in the second Closed Captioning Packet
for SD video output
Type: String
Values: "None", "CEA 708", "SCTE-20"

POST Examples:
Example 1: Changing one SD Transcoding Parameter

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
250
API Definitions
Transcoding Configuration Commands

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 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/sd/transcode?index=5&bitratemode=CBR"
If successful, the following is an example of the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Example 2: Changing multiple SD Transcoding Parameters
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 changes several HD transcoder 5 parameters.
It will set the bitratemode to CBR, bitrate to 14 and, pulldown32 to Disabled.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/
service_cfg/transcode/sd?index=5&bitratemode=CBR&bitrate=14&pulldown32=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. You must
change the IP to the specific unit IP in use. The following example retrieves all of the SD transcoder settings
for transcoder 5.

Note The user must specify the index in the URI.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/transcode/sd?index=5"
If successful, the following is an example of the return body:
"transcode": {
"sd": {
"index": "5",
"vres": "SD Output",
"hres": "720",
"bitratemode": "CBR",
"bitrate": "4.0",
"gop": "User GOP(MN)",
"usergop": "15 2",
"pulldown32": "Disabled",
"aspectratio": "16:9",
"aspectconv": "None",
"ccpkt1": "CEA 708",
"ccpkt2": "None"
}
}
Example 4: GET a specific SD transcode value 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. You must

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
251
 API Definitions
Transcoding Configuration Commands

change the IP to the specific unit IP in use. The following example retrieves one specific parameter value
from the ASI tuning settings for ASI port 1.

Note The user must specify the port number in the URI followed by the URI argument the user wishes to retrieve.
This example retrieves the bitrate 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.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/transcode/sd?index=5&bitrate"
If successful, the following is an example of the return body:
"transcode": {
"sd": {
"index": "5",
"bitrate": "14.0"
}
}
Example 5: GET multiple 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. 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.

Note The user must specify the index number in the URI followed by the URI arguments the user wishes to
retrieve. The following example retrieves the bitratemode, bitrate and 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.

curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k

"https://192.168.0.1/ws/v2/service_cfg/transcode/sd?index=5&bitratemode&bitrate&pulldown32"
If successful, the following is an example of the return body:
"transcode": {
"sd": {
"index": "5",
"bitrate": "14.0",
"bitratemode": "CBR",
"pulldown32": "Disabled"
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
252
API Definitions
Transcoding Configuration Commands

SUBT (Subtitle) Transcode Configuration Command

Table 211: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/transcode/subt

Command Information Allows set or get of subtitles transcode configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All SUBT transcode Settings

GET "https://192.168.0.1/ws/v2/service_cfg/transcode/subt"
Single SUBT transcode Setting
GET "https://192.168.0.1/ws/v2/service_cfg/transcode/subt?opmode"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/transcode/subt?

index=1&opmode=Off"
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

Note 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 the table.

Table 212: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

index (Key) Transcoder to be configured
Type: Integer
Values: 1..N (number of transcoders depends on model and installed
options)

opmode Operational Mode of Subtitle

Type: String
Value: "Off", "On", "Imitext", "DVB"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
253
 API Definitions
Transcoding Configuration Commands

URI Argument Description

langmenu Language Menu Options
Type: String
Value: "Language List", "Language Entry", "PMT Order"

pmtorder PMT Order of Subtitle PID

Type: String
Values: "First", "Second", "Third", "Fourth", "Fifth", "Sixth",
"Seventh", "Eighth"

langlist Language List

Type: String
Value: 3 character language string

langentry Language Entry

Type: String
Value: 3 character language string

imitext imitext Position

Type: String
Values: "Standard", "Extended"

foregndcol Foreground Color

Type: String
Values: "Auto", "Yellow", "White"

backgndcol Foreground Color

Type: String
Values: "None", "Auto", "Shadow", "Opaque", "Semi"

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 "Accept: application/json" -H
"X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/
subt?index=5&opmode=Imitext"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
254
API Definitions
Transcoding Configuration Commands

"message": ""
}
Example 2: Changing multiple SUBT Transcoding Parameters
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 changes several SUBT transcoder 5
parameters. It will set the opmode to "Imitext", langmenu to "PMT Order" and pmtorder to "Second".
curl -X POST -i -H "Accept: application/json" -H
"X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/
subt?index=5&opmode=Imitext&langmenu=PMT%20Order&pmtorder=Second"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}
GET Examples:
Example 3: GET the full SUBT 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. You must
change the IP to the specific unit IP in use. The following example retrieves all of the SUBT transcoder settings
for transcoder 5.

Note The user must specify the index in the URI.

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",
"pmtorder": "Second",
"langlist": "eng",
"langentry": "eng",
"imitext": "Standard",
"foregndcol": "Auto",
"backgndcol": "Auto"
}
}
}
Example 4: GET a specific SUBT transcode value 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. You must
change the IP to the specific unit IP in use. The following example retrieves one specific parameter value
from the ASI tuning settings for ASI port 1.

Note The user must always specify the port number in the URI followed by the URI argument the user wishes
to retrieve. This example retrieves the langmenu from transcoder 5.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
255
 API Definitions
User Configuration Command

Note In GET URIs only, the index argument must contain a value for the transcoder, all other arguments so not
contain values.

curl -X GET -i -H "Accept: application/json" -H

"X-SESSION-ID: $token" -k "https://192.168.0.1/ws/v2/service_cfg/transcode/
subt?index=5&langmenu"
If successful, the following is an example of the return body:
{
"transcode": {
"subt": {
"index": "5",
"langmenu": "PMT Order"
}
}
}
Example 5: GET multiple SUBT 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. 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.

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

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&langmenu&langentry&foregndcol"
If successful, the return body will be:
{
"transcode": {
"subt": {
"index": "5",
"foregndcol": "Auto",
"langentry": "eng",
"langmenu": "PMT Order"
}
}
}

User Configuration Command

Table 213: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/user

Command Information Allows set or get of user configuration.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
256
API Definitions
User Configuration Command

Command Detail Description

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All user configuration settings:

GET https://192.168.0.1/ws/v2/service_cfg/user
Single user configuration setting:
GET "https://192.168.0.1/ws/v2/service_cfg/user?lossofinput"

POST Syntax POST "https://192.168.0.1/ws/v2/service_cfg/user?

lossofinput=No%20Output"

URI Parameters: (extension to the Command URL separated by /): N/A

Note All of the URI Arguments below apply to both GET and POST. In-depth CURL examples can be
seen below following the table.

Table 214: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

lossofinput Select whether outputs should transmit black or not
transmit any data when there is a loss of input
Type: String
Value: "Black Output", "No Output"

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 example changes the lossofinput parameter to "No
Output".

Note These elements do not currently support the use of JSON.

curl -k -X POST -H "X-SESSION-ID:$token"

"https://192.168.0.1/ws/v2/service_cfg/user?lossofinput=No%20Output"
If successful, the following is an example of the return body:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<response><code>10</code><result>success</result><message></message></response>
GET Examples:

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
257
 API Definitions
Disaster Recovery (D/R) Configuration API

Example 2: GET the full set of user parameters

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 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"
If successful, the following is an example of the return body:
"user": {
"lossofinput": "No Output"
}
Example 3: GET a specific 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 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 commands.

Disaster Recovery (D/R) Global Configuration Command

Table 215: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/dr/global

Command Information Allows set or get of D/R global configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All D/R global Settings

GET "https://192.168.0.1/ws/v2/service_cfg/dr/global"
Single D/R global Setting, for example,
GET "https://192.168.0.1/ws/v2/service_cfg/dr/global?enable"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
258
API Definitions
Disaster Recovery (D/R) Configuration API

Command Detail Description

POST Syntax For example,
Setting Parameters using POST "https://192.168.0.1/ws/v2/service_cfg/dr/global?enable=No"
command line arguments is
limited to maximum of 26
arguments after the ?.

URI Parameters (extension to the Command URL separated by /): N/A

Note For POST, the value for the argument seen below must be specified, but for GET, there are no values
for arguments.

Table 216: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

enable Enable or Disable D/R Feature
Type: String
Value: "Yes", "No"

siglock Amount of time to wait before declaring signal is locked

Type: Integer
Value: 5 … 255 c

siglost Amount of time to wait before declaring signal is lost

Type: Integer
Value: 5 … 2160000

verify Amount of time allowed for verification to complete

Type: Integer
Value: 10 … 255

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 IP of the unit is 192.168.0.1. You must
change the IP to the specific unit IP in use. This example set the commode to Std.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/dr/global?&siglock=40"
If successful, the return body will be:
"response": {
"code": "10",
"result": "success",
"message": ""
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
259
 API Definitions
Disaster Recovery (D/R) Configuration API

GET Examples
Example 2: Retrieve the full D/R global 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 use.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/dr/global"
If successful, the return body will be:
"dr": {
"global": {
"enable": "Yes",
"siglock": "40",
"siglost": "120",
"verify": "60",
"profile": "Local"
}
}

Note The "profile" parameter is only for display, configuring the parameter is not currently supported.

Disaster Recovery (D/R) Backup Transport Configuration Command

Table 217: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/dr/tuning

Command Information Allows set or get of D/R backup transport configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All D/R backup tuning Settings

GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning"
Single D/R backup tuning Setting, for example,
GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=1",
GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=2", or
GET "https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=3"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
260
API Definitions
Disaster Recovery (D/R) Configuration API

Command Detail Description

POST Syntax POST, for example,
"https://192.168.0.1/ws/v2/service_cfg/dr/tuning?csirec=1&dnlkfreq=3.53"
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

Note For POST, the value for the argument seen below must be specified, but for GET, there are no values
for arguments.

Table 218: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

csirec (Key) Record index of D/R backup tuning configuration
Type: Integer
Values: 1 … 3

rowstatus D/R backup tuning status

Type: String
Values: "Active", "Inactive"

input D/R backup tuning RF input selection

Type: String
Values: "RF1", "RF2", "RF3", "RF4"

netid D/R backup tuning network id

Type: Integer
Values: 0 … 65535

dnlkfreq D/R backup tuning Frequency [GHz]

Type: Float
Values: 0.0 … 15.0

symrate D/R backup tuning RF symbol rate

Type: Float
Values: 1.0 … 45.0

mod D/R backup tuning RF modulation system

Type: String
Values: "DVB-S", "DVB-S2"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
261
 API Definitions
Disaster Recovery (D/R) Configuration API

URI Argument Description

fec D/R backup tuning FEC Mode
Type: String
Values: "Auto", "1/2", "2/3", "3/4", "5/6", "7/8", "8/9"

rolloff D/R backup tuning RF rolloff

Type: String
Values: ".20", ".25", ".35", "Auto"

POST Examples
Example 1: Set various D/R backup transport 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. This example set the commode to Std.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/dr/tuning?&csirec=1&rowstatus=Active&input=RF2
&dnlkfreq=3.53&symrate=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 use.
curl -X GET -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/dr/tuning"
If successful, the return body will be:
"dr": {
"tuning": [
{
"csirec": "1",
"fec": "Auto",
"dnlkfreq": "3.53",
"input": "RF2",
"mod": "DVB-S",
"netid": "1",
"symrate": "30.0",
"rolloff": ".35",
"rowstatus": "Active"
},
{
"csirec": "2",
"fec": "Auto",
"dnlkfreq": "3.449",
"input": "RF1",
"mod": "DVB-S",
"netid": "1",
"symrate": "28.3465",
"rolloff": ".35",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
262
API Definitions
Disaster Recovery (D/R) Configuration API

"rowstatus": "Inactive"
},
{
"csirec": "3",
"fec": "Auto",
"dnlkfreq": "3.449",
"input": "RF1",
"mod": "DVB-S",
"netid": "1",
"symrate": "28.3465",
"rolloff": ".35",
"rowstatus": "Inactive"
}
]
}

Disaster Recovery (D/R) Backup Channels Configuration Command

Table 219: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/service_cfg/dr/channels

Command Information Allows set or get of D/R backup channel configuration.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All D/R backup channels Settings

GET "https://192.168.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"
POST Syntax POST, for example,
Setting Parameters using "https://192.168.0.1/ws/v2/service_cfg/dr/channels?peid=PE1&csirec=1&bkpchan=201"
command line arguments is
limited to maximum of 26
arguments after the ?.

URI Parameters (extension to the Command URL separated by /): N/A

Note For POST, the value for the argument seen below must be specified, but for GET, there are no values
for arguments.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
263
 API Definitions
Disaster Recovery (D/R) Configuration API

Table 220: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

peid (Key) D/R backup channel Program Entry ID
Type: String
Values: "PE1" … "PE16"

csirec (Key) Record index of D/R backup Transport

Type: Integer
Values: 1 … 3

bkpchan D/R backup channel number

Type: Integer
Values: 0 … 65535

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 IP of the unit is 192.168.0.1. You must
change the IP to the specific unit IP in use. This example set the commode to Std.
curl -X POST -i -H "Accept: application/json" -H "X-SESSION-ID: $token" -k
"https://192.168.0.1/ws/v2/service_cfg/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 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/dr/channels"
If successful, the return body will be:
"dr": {
"channels": [
{
"peid": "PE1",
"csirec": "1",
"bkpchan": "201",
},
{
"peid": "PE1",
"csirec": "2",
"bkpchan": "0",
},
{
"peid": "PE1",

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
264
 API Definitions
Device Control Commands

"csirec": "3",
"bkpchan": "0",
},
{
"peid": "PE2",
"csirec": "1",
"bkpchan": "0",
},
.
.
.
]
}

Device Control Commands

This section lists all the device control commands.

Ethernet Device Control Command

Table 221: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/device_ctl/eth
https://192.168.0.1/ws/v2/device_ctl/eth/<Level_1_URI_Parameter>

Command Information Allows get of Ethernet ports information or configuration of Ethernet

data or control ports.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All port Info:

This command uses the ports GET "https://192.168.0.1/ws/v2/device_ctl/eth"
referenced in Port Information, Single Ethernet port info:
on page 8.
GET "https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=1"
However in this API, all of the
port numbers have +1 added. As Single Ethernet port item:
a result, the Management Port is GET "https://192.168.0.1/ws/v2/device_ctl/eth/port? portid=1&ipv4addr"
port1, DATA1 is port2, and
DATA2 is port3, and so on.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
265
 API Definitions
Ethernet Device Control Command

Command Detail Description

POST Syntax Change management port configuration:
Setting parameters using POST "https://192.168.0.1/ws/v2/device_ctl/eth/port?
command line arguments is portid=1&ipv4addr=[ipa.ddr.ess.one]"
limited to maximum of 26 Where [ipa.ddr.ess.one] = valid ipv4 address on port 1 subnet
arguments after the ?.
If changing the subnet, then the change data port configuration:
For Ethernet ports configuration,
only HTTP data body is POST "https://192.168.0.1/ws/v2/device_ctl/eth/port?
supported. POST from portid=2&ipv4addr=[ipa.ddr.ess.two]"
XML/JSON file is not supported. Where [ipa.ddr.ess.two] = valid ipv4 address on port 2's subnet

Table 222: Level_1 URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

port Indicates that port parameters will be 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.

Note 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 the table.

Table 223: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

portid (Key) Ethernet Port Identification
Type: digit
Value: 1, 2, 3
Notes: 1 - Management Port
2 – DATA1
3 – DATA2
4 – DATA3
5 – DATA4

name (Read-Only) Ethernet Port Name

Type: string
Value: control, data1, data2

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
266
API Definitions
Ethernet Device Control Command

URI Argument Description

ipver IP version selection
Type: String
Value: IPv4, IPv6
Note Only IPv4 is currently
supported.
ipv4addr IP V4 Address
Type: String
Value: IP address, for example, 192.168.0.1

ipv4mask IP V4 mask
Type: digit
Value: 8..30

ipv4defgw IP V4 Default Gateway

Type: String
Value: IP address, for example, 192.131.244.254

phymode IP Physical Port Mode

Type: String
Value: Auto, 10HD, 10FD, 100HD, 100FD, 1000FD

GET Method Examples:

Display physical Ethernet Port information in XML or JSON. It can be used to display all ports information
or specific 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.254</ipv4defgw>
<phymode>Auto</phymode>
</port>
<port>
<portid>2</portid>
<name>Data1</name>
<ipver>IPv4</ipver>
<ipv4addr>192.168.1.2</ipv4addr>
<ipv4mask>24</ipv4mask>
<ipv4defgw>192.168.1.254</ipv4defgw>
<phymode>Auto</phymode>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
267
 API Definitions
Ethernet Device Control Command

</port>
<port>
<portid>3</portid>
<name>Data2</name>
<ipver>IPv4</ipver>
<ipv4addr>192.168.1.3</ipv4addr>
<ipv4mask>24</ipv4mask>
<ipv4defgw>192.168.1.254</ipv4defgw>
<phymode>Auto</phymode>
</port>
</eth>
</devicectl>
Show a single port information in XML format:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=1"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<devicectl>
<eth>
<port>
<portid>1</portid>
<name>Management</name>
<ipver>IPv4</ipver>
<ipv4addr>192.168.0.1</ipv4addr>
<ipv4mask>24</ipv4mask>
<ipv4defgw>192.168.0.254</ipv4defgw>
<phymode>Auto</phymode>
</port>
</eth>
</devicectl>
Show a single port item in JSON format:
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=2&ipv4addr&js=1"
Expected output (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 configurations is only supported from
HTTP POST body.
Management port:
curl -k -X POST -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=1&ipv4addr=192.168.0.0&js=1"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}
Data Port:
curl -k -X POST -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/eth/port?portid=2&ipv4addr=192.131.244.7&js=1"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
268
 API Definitions
Version Selection Device Control Command

If successful, the following is an example of the return body:

"response": {
"code": "10",
"result": "success",
"message": ""
}

Version Selection Device Control Command

Table 224: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/device_ctl/ver
https://192.168.0.1/ws/v2/device_ctl/ver/<Level_1_URI_Parameter>

Command Information Allows getting all runnable software version information, selecting a
software version or deleting a software version.

HTTP Methods GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All version Info

GET "https://192.168.0.1/ws/v2/device_ctl/ver"

POST Syntax Select a version:

Only HTTP data body is POST "https://192.168.0.1/ws/v2/ver/verselect? idx=[s/w version
supported. POST from idx#]&reboot=Yes"
XML/JSON file is not supported. Delete a version:

POST "https://192.168.0.1/ws/v2/ver/verselect? idx=[s/w version

idx#]&erase=Yes"

Table 225: Level_1 URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

verselect Version to be selected
URI Query/Set Arguments below are only valid when
this level URI parameter is used

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
269
 API Definitions
Version Selection Device Control Command

Note All of the URI Arguments below apply to both GET and POST except where indicated. 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. Various CURL examples can be seen below
.

Table 226: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

idx (Key) Software version index
Type: Digit
Value: 0 ~ 8

name Software version Name

Type: String
Value: software version naming format, for example,
T0.10B7(T0.10B5)
Note For POST command syntax, this option is not used. It is valid
as exist (no value) filter for GET command, also in the output
data.
reboot To run the software version to be selected
Type: String
Value: Yes, No

erase To delete the software version to be selected.

Type: String
Value: Yes, No

js 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

GET Method Examples:

Display runnable software versions information in XML or JSON.
Show all version info in XML:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/ver"
Expected output (values are for example purposes only):
<?xml version="1.0" encoding="ISO-8859-1" ?>
<devicectl><ver><verselect><idx>0</idx><name>1.10</name><reboot>No</reboot><erase>No</erase>
</verselect><verselect><idx>1</idx><name>T2.25C1</name><reboot>No</reboot><erase>No</erase>
</verselect><verselect><idx>2</idx><name>T2.25B7</name><reboot>No</reboot><erase>No</erase>
</verselect><verselect><idx>3</idx><name></name><reboot>No</reboot><erase>No</erase></verselect>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
270
API Definitions
Version Selection Device Control Command

<verselect><idx>4</idx><name></name><reboot>No</reboot><erase>No</erase></verselect><verselect>
<idx>5</idx><name></name><reboot>No</reboot><erase>No</erase></verselect><verselect><idx>6</idx>
<name></name><reboot>No</reboot><erase>No</erase></verselect><verselect><idx>7</idx><name>
</name><reboot>No</reboot><erase>No</erase></verselect><verselect><idx>8</idx><name></name>
<reboot>No</reboot><erase>No</erase></verselect></ver></devicectl>
Show 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 delete the software version.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
271
 API Definitions
Reset Device Control Command

Select a version:
curl -k -X POST -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/ver/verselect?idx=1&reboot=Yes&js=1"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}
And system will reboot successfully to the new version.
Delete a version:
curl -k -X POST -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/ver/verselect?idx=2&erase=Yes&js=1"
If successful, the following is an example of the return body:
"response": {
"code": "10",
"result": "success",
"message": ""
}

Reset Device Control Command

Table 227: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/device_ctl/reset/<Level_1_URI_Parameter>

Command Information 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.

HTTP Method POST

Access Type Write

Access Level User, Admin

GET Syntax N/A

POST Syntax Factory Reset:

Only HTTP data body is POST "https://192.168.0.1/ws/v2/device_ctl/reset/factory"
supported. POST from Reboot:
XML/JSON file is not supported.
POST "https://192.168.0.1/ws/v2/device_ctl/reset/reboot"

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
272
API Definitions
Reset Device Control Command

Table 228: Level_1 URI Parameters (extension to the Command URL separated by /)

URI Parameter Description

factory Do a factory reset.

reboot Reboot the unit.

Table 229: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

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

POST Method Examples:

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:
"response": {
"code": "10",
"result": "success",
"message": ""
}
The system will reboot successfully to the same version (after about 1 minute).

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
273
 API Definitions
Protocol Device Control

Protocol Device Control

Table 230: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/device_ctl/protocols

Command Information Allows getting and setting device controls for protocols such as
HTTP, SNMP, IGMP, and so on.

HTTP Method(s) GET, POST

Access Type Read, Write

Access Level User, Admin

GET Syntax All protocol device control info:

GET "https://192.168.0.1/ws/v2/device_ctl/protocols"
Single protocol device control item:
GET "https://192.168.0.1/ws/v2/device_ctl/protocols?http"

POST Syntax Change SNMP protocol configuration:

Only HTTP data body is supported. POST
POST from XML/JSON file is not "https://192.168.0.1/ws/v2/device_ctl/protocols?snmp=Enable"
supported. Change IGMP protocol configuration:
POST
"https://192.168.0.1/ws/v2/device_ctl/protocols?igmp=Disable"

Table 231: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

http HTTP Protocol Control
Type: String
Value: Disable, HTTP, HTTPS

snmp SNMP Protocol Control

Type: String
Value: Disable, Enable

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
274
API Definitions
Protocol Device Control

URI Argument Description

igmp IGMP Protocol Control
Type: String
Value: Disable, Enable

syslog Syslog Mode of Operation

Type: String
Value: Disable, Syslog TCP, Syslog UDP

slogsrvip Syslog Server IP Address

Type: String
Value: IP address, for example, 0.0.0.0

slogsrvprt Syslog Server Port

Type: Digit
Value: IP port, for example, 514

mpe MPE Data Filter Mode

Type: String
Value: Fwd None, Fwd All, Fwd Filtered

idletimeout Protocol Idle Timeout

Type: Digit
Value: 0, 30 ~ 1209600 inclusive

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

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>HTTPS</http><snmp>Enable</snmp><igmp>Enable</igmp>
<syslog>Syslog UDP</syslog><slogsrvip>0.0.0.0</slogsrvip><slogsrvprt>514</slogsrvprt>
<mpe>Fwd None</mpe><idletimeout>0</idletimeout><globaldns>Enable</globaldns></settings>
</protocols></devicectl>

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
275
 API Definitions
Protocol Device Control

2 Show all protocol control info in JSON:

curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/device_ctl/protocols?js=1"
Expected output (values are for example purposes only):
{
"devicectl": {
"protocols": {
"settings": {
"http": "HTTPS",
"snmp": "Enable",
"igmp": "Enable",
"syslog": "Syslog UDP",
"slogsrvip": "0.0.0.0",
"slogsrvprt": "514",
"mpe": "Fwd None",
"idletimeout": "0",
"globaldns": "Enable"
}
}
}
}
3 Show a single protocol control item in JSON:
curl -k -H "X-SESSION-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/protocols?http&js=1"
Expected output (values are for example purposes only):
{
"devicectl": {
"protocols": {
"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-ID: $token"
"https://192.168.0.1/ws/v2/device_ctl/protocols?igmp=Disable&js=1"
If successful, the return body will be:
{
"response": {
"code": "10",
"result": "success",
"message": "Success"
}
}
And IGMP protocol will be disabled.

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
276
 API Definitions
Download Device Control Settings

Download Device Control Settings

For a description of the ws/v2/device_ctl/download command, refer to Determining Support for Chunky CDT
Upload Command, on page 19.
This command is available for Version 2.75 or later. The previous versions returns HTTP 404 Not Found
error.

Diagnostics API
This section contains APIs that Administrators and Users may use to diagnose specific functionality on a
D9800 platform.

Note This is different from the APIs used for Diagnostics Package creation and retrieval (referred to as Export
Debug File operations on the D9800 web GUI).

IP Diagnostics Commands
The following is a list of the Client software requirements:
IP Diagnostics command may take up to 30 seconds, depending on status of the specified port and destination
ip_address.
To avoid blocking of the D9800 integrated applications, and to implement the Progress Bar feature on the
web GUI, the required client software operation is a four phase approach:
1 Trigger a request for IP diagnostic.
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 the GET API response elements into a format (for example, text box
Window on the web GUI) that is useful to the user.

The APIs that are involved in Steps 1 to 3 above are described below.

IP Diagnostics Trigger Command

Table 232: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v2/ip_diags/trigger

Command Information Trigger the ip_diags command.

HTTP Method POST

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
277
 API Definitions
IP Diagnostics Commands

Command Detail Description

Access Type Write

Access Level User, Admin

POST Syntax POST

"https://192.168.0.1/ws/v2/ip_diags?command=[command_option]&
port=[ip_port_name]&ip=[target_ipv4_address]"

Table 233: URI Query/Set Arguments (possible fields and values preceded by ? and separated by &)

URI Argument Description

command Specify the command type. The types are:
(mandatory) ping - performs ping command
tracert - performs traceroute command

port Specify the output port.

(mandatory) For multi-stream unit:
0 : Management port
1: Data Port 1
2: Data Port 2
3: Data Port 3
4: Data Port 4
For single-stream unit:
0 : Management port
1: Data Port 1
2: Data Port 2

ip Specify the target IPv4 address.

(mandatory) Type: String (ip dot format)

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 Success case which indicates only that IP Diag command was started):
In XML:
HTTP/1.1 200 OK
Date: Mon, 26 Jun 2017 11:58:09 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
278
API Definitions
IP Diagnostics Commands

Status: 200
Content-type: application/xml

<?xml version="1.0" encoding="ISO-8859-1"

?><response><code>0</code><result>success</result><message>ping data collection is in
progress</message></response>
In JSON:
HTTP/1.1 200 OK
Date: Mon, 26 Jun 2017 12:00:15 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/json

{
"response": {
"code": "0",
"result": "success",
"message": "ping data collection is in progress"
}
}
Expected output (for Fail case which indicates that IP Diag Package Preparation was not started):

Note Additional failure reason details may be available by calling the DIAGSTAT API.

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, 26 Jun 2017 12:00:15 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/json

{
"response": {
"code": "10",
"result": "failure",
"message": "failure to trigger request "
}
}

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
279
 API Definitions
IP Diagnostics Commands

IP Diagnostics Operation Status Command

Table 234: Command Details

Command Detail Description

Command URL https://192.168.0.1/ws/v1/table?t=IPDIAGSTAT

Command Information Return information about IP Diagnostics Status.

HTTP Method GET

Access Type Read

Access Level User, Admin

GET Syntax GET "https://192.168.0.1/ws/v1/table?t=IPDIAGSTAT"

Example (issue the IP DIAG Status command):

Input:
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v1/table?t=IPDIAGSTAT"
Expected output (example when diagnostics package preparation is in progress):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Inprogress]]></VALUE><NAME>
<![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent
operation passed, failed, or is in progress]]>
</HELP_STR_1><HELP_STR_2><![CDATA[This item has 3 options available.]]></HELP_STR_2>
</ITEM><ITEM><ID>0x002D2601</ID><VALUE><![CDATA[Processing]]></VALUE><NAME><![CDATA[DETAILEDSTATUS]]>
</NAME><HELP_STR_1><![CDATA[State of the current Ping Traceroute collection
operation]]></HELP_STR_1>
<HELP_STR_2><![CDATA[This item has 6 options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D2602</ID>
<VALUE><![CDATA[23]]></VALUE><NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1>
<![CDATA[Progress of the current Ping Traceroute Collection 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 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>0x002D2601</ID><VALUE><![CDATA[Done]]></VALUE>
<NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of the current
Ping Traceroute collection operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 6
options
available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D2602</ID><VALUE><![CDATA[100]]></VALUE>
<NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress of the current Ping
Traceroute Collection 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 ip diagnostics operation did not succeed):
<?xml version="1.0" encoding="ISO-8859-1"
?><HDR><TABLE><RECORD><ITEM><ID>0x002D2600</ID><VALUE><![CDATA[Fail]]></VALUE>
<NAME><![CDATA[OPERSTATUS]]></NAME><HELP_STR_1><![CDATA[Indicates whether the most recent

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
280
API Definitions
IP Diagnostics Commands

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>0x002D2601</ID><VALUE><![CDATA[Failed]]>
</VALUE><NAME><![CDATA[DETAILEDSTATUS]]></NAME><HELP_STR_1><![CDATA[State of the current
Ping
Traceroute collection operation]]></HELP_STR_1><HELP_STR_2><![CDATA[This item has 6 options

available.]]></HELP_STR_2></ITEM><ITEM><ID>0x002D2602</ID><VALUE><![CDATA[100]]></VALUE>
<NAME><![CDATA[PERCENTCOMPLETE]]></NAME><HELP_STR_1><![CDATA[Progress of the current
Ping Traceroute Collection 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 calling this API every 5 seconds, while the Inprogress state
is active, and until the OPERSTATUS is Pass and PERCENTCOMPLETE is 100 or OPERSTATUS is Fail.
The first call will wait a minimum of 1 second, after the IP diagnostics trigger API, in order 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

Command Detail Description

Command URL https://192.168.0.1/ws/v2/ip_diags

Command Information Retrieves the last IP diagnostics report (after last 100% completed
operation status).

HTTP Method GET

Access Type Read

Access Level User, Admin

Restricted to Lock Level 0 only.

GET Syntax GET "https://192.168.0.1/ws/v2/ip_diags"

Options: NA
Example (issue the IP diagnostics retrieval command):
Input (append &js for output in JSON format):
curl -k -H "X-SESSION-ID: $token" "https://192.168.0.1/ws/v2/ip_diags"
Expected output (example for Success case which indicates only that Diag Package Retrieval was
completed):
XML format:
HTTP/1.1 200 OK
Date: Mon, 26 Jun 2017 13:00:58 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/xml

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
281
 API Definitions
IP Diagnostics Commands

<?xml version="1.0" encoding="ISO-8859-1"

?><response><code>0</code><result>success</result><message1>PING 10.132.24.34 (10.132.24.34):
56 data bytes
64 bytes from 10.132.24.34: seq=0 ttl=61 time=0.819 ms
64 bytes from 10.132.24.34: seq=1 ttl=61 time=1.498 ms
64 bytes from 10.132.24.34: seq=2 ttl=61 time=0.740 ms
64 bytes from 10.132.24.34: seq=3 ttl=61 time=0.687 ms
64 bytes from 10.132.24.34: seq=4 ttl=61 time=0.677 ms

--- 10.132.24.34 ping statistics ---

5 packets transmitted, 5 packets rece</message1><message2>ved, 0 percent packet loss
round-trip min/avg/max = 0.677/0.884/1.498 ms
</message2></response>
JSON format:
HTTP/1.1 200 OK
Date: Mon, 26 Jun 2017 13:02:55 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 200
Content-type: application/json

{
"response": {
"code": "0",
"result": "success",
"message1": "PING 10.132.24.34 (10.132.24.34): 56 data bytes\n64 bytes 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.677/0.884/1.498
ms\n"
}
}
Expected output (example for Fail case which indicates that IP Diag report retrieval could not be
completed):

Note Additional failure reason details may be available by calling the IPDIAGSTAT API.

You can put unrecognized parameter (for example, /extra) on command line to test this case:
curl -i -k -H "X-SESSION-ID: $token" "https://10.85.163.98/ws/v2/ip_diags/extra"
HTTP/1.1 404 Not Found
Date: Mon, 26 Jun 2017 13:06:33 GMT
Server: Hiawatha v9.14
Connection: keep-alive
Transfer-Encoding: chunked
Status: 404

Cisco D9800 Network Transport Receiver Version 2.75 RESTful Web Services API Reference Guide
282