TN iVantageAPI T0000960 RevC 12 11 18

Technical Note Evolution
Technical Note
Evolution
iVantage API
iDX Release 4.1

Copyright © 2018, Inc. All rights reserved. Reproduction in whole or in part without permission is prohibited.
Information contained herein is subject to change without notice. The specifications and information regarding the
products in this document are subject to change without notice. All statements, information and recommendations
in this document 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. Trademarks, brand names and products
mentioned in this document are the property of their respective owners. All such references are used strictly in an
editorial fashion with no intent to convey any affiliation with the name or the product's rightful owner.
VT iDirect is a global leader in IP-based satellite communications providing technology and solutions that enable our
partners worldwide to optimize their networks, differentiate their services and profitably expand their businesses.
Our product portfolio, branded under the name iDirect, sets standards in performance and efficiency to deliver
voice, video and data connectivity anywhere in the world. VT iDirect is the world’s largest TDMA enterprise VSAT
manufacturer and is the leader in key industries including mobility, military/government and cellular backhaul.
VT iDirect
Company Web site: http://www.idirect.net ~ Main Phone: 703.648.8000
TAC Contact Information: Phone: 703.648.8151 ~ Email: tac@idirect.net ~ Web site: http://tac.idirect.net
iDirect Government™, created in 2007, is a wholly owned subsidiary of iDirect and was formed to better serve the
U.S. government and defense communities.
iDirect Government™
Company Web site: http://www.idirectgov.com ~ Main Phone: 703.648.8118
TAC Contact Information: Phone: 703.648.8111 ~ Email: tac@idirectgov.com ~ Web site: http://tac.idirectgov.com
Document Name: TN_iVantageAPI__T0000960_RevC_12_11_18

Document Part Number: T0000960
ii Technical Note
Evolution | T0000960 | Rev A
Revision History
Revision History
The following table shows all revisions for this document. To determine if this is the latest
revision, check the Technical Assistance Center (TAC) Web site. Refer to Getting Help on
page viii for TAC access information.
Revision Date Updates

A 11/15/2017 Initial release of the document.
B 06/18/2018 Updated for iDX Release 4.1.1.
C 12/14/2018 Updated for iDX Release 4.1.2.
Technical Note iii

Evolution | T0000960 | Rev C
Revision History
iv Technical Note
Contents
Contents
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
Getting Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii
Document Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
API Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
API Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Configuring the API Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
HTTP Basic Access Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Session Cookie Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Logging In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Session Cookie Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Logging Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Session Timeout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
GET: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
example Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Technical Note v
Contents
example response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
example Call 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
example response 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
example Call 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
example response 3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
POST: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
example Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
example Response. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
PATCH: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
example Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
example response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
DELETE: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
example Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
example response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
vi Technical Note
About
About
Purpose
This document provides only a resource tree (list of commands) necessary for controlling and
monitoring an iDirect Evolution NMS. It does not explain the Web Services Interface concept
or general structure and syntax.
Audience
The intended audience for this document is the System Engineering team responsible for
interfacing with iDirect products. It is expected that the reader has a working knowledge of
machine to machine interfacing, software programming, and the REST architectural
approach.
Contents
This document contains the following major sections:
• Introduction
This chapter provides an introduction to the iVantage API.
Document Conventions
This section illustrates and describes the conventions used throughout this document.
Convention Description Example

Command Used when the user is required to Type the command:
type a command at a command cd /etc/snmp/
line prompt or in a console.
Terminal Used when showing resulting crc report all
Output output from a command that was 8350.3235 : DATA CRC [ 1]
entered at a command line or on a 8350.3502 : DATA CRC [5818]
console. 8350.4382 : DATA CRC [ 20]
Technical Note vii

About
Convention Description Example

Screen Used when referring to text that 1. To add a remote to an inroute group, right-click
Reference appears on the screen on a the Inroute Group and select Add Remote.
Graphical User Interface (GUI). The Remote dialog box has a number of user-
Used when specifying names of selectable tabs across the top. The Information
commands, menus, folders, tabs, tab is visible when the dialog box opens.
dialogs, list boxes, and options.
Hyperlink Used to show all hyperlinked text For instructions on adding a line card to the
within a document or external network tree, see Adding a Line Card on
links such as web page URLs. page 108.
WARNING: A warning highlights an essential operating or maintenance procedure,

practice, condition, or statement which, if not strictly observed, could result in
injury, death, or long term health hazards.
CAUTION: A caution highlights an essential operating or maintenance procedure,

practice, condition, or statement which, if not strictly observed, could result in
damage to, or destruction of, equipment or a condition that adversely affects
system operation.
NOTE: A note is a statement or other notification that adds, emphasizes, or

clarifies essential information of special importance or interest.
Getting Help
The iDirect Technical Assistance Center (TAC) and the iDirect Government Technical
Assistance Center (TAC) are available to provide assistance 24 hours a day, 365 days a year.
Software user guides, installation procedures, FAQs, and other documents that support iDirect
and iDirect Government products are available on the respective TAC Web site:
• Access the iDirect TAC Web site at http://tac.idirect.net
• Access the iDirect Government TAC Web site at http://tac.idirectgov.com
The iDirect TAC may be contacted by telephone or email:
• Telephone: 703.648.8151
• E-mail: tac@idirect.net
The iDirect Government TAC may be contacted by telephone or email:
• Telephone: 703.648.8111
• Email: tac@idirectgov.com
iDirect and iDirect Government produce documentation that are technically accurate, easy to
use, and helpful to our customers. Please assist us in improving this document by providing
feedback. Send comments to:
• iDirect: techpubs@idirect.net
viii Technical Note

About
• iDirect Government: techpubs@idirectgov.com

For sales or product purchasing information contact iDirect Corporate Sales at the following
telephone number or e-mail address:
• Telephone: 703.648.8000
• E-mail: sales@idirect.net
Document Set
The following iDirect documents are available at TAC and contain information relevant to
installing and using iDirect satellite network software and equipment. Refer to Getting Help
on page viii for TAC access information.
• Release Notes
• Software Installation Guide or Network Upgrade Procedure Guide
• iBuilder User Guide
• iMonitor User Guide
• Installation and Commissioning Guide for Remote Satellite Routers
• Features and Chassis Licensing Guide
• Software Installation Checklist/Software Upgrade Survey
• Link Budget Analysis Guide
• TRANSEC User Guide
• Technical Note on Setting Up Defense and Universal Line Cards (DLC/ULCs)
Technical Note ix
About
x Technical Note
Introduction
The Webservices iVantage API is a new tool supported on Evolution. This API is built on RESTful
Web design principles, the industry-leading way that Web interfaces are built today, and relies
on HTTPS and JSON messaging as the means for encoding.
The iVantage API commands enables machine to machine routines to automate provisioning
and commissioning to improve network operator's productivity.
The API commands can be used to create, read, update, and delete (CRUD) iBuilder
configurations. Functions that are available to modify through iBuilder are now available
within the API. Accessible configuration parameters include remote model, management and
LAN IP addresses, power, CIR and MIR, QoS profile assignment, and so on.
The API also enables reading basic BUC, LNB, network, carrier, inroute group, and spacecraft
information which helps in adding a remote.
Swagger.io is the online documentation engine and is accessible through the web browser
pointed to the NMS. See, https://nodenms_server.
Figure 1-1. NMS-Server Architecture
Technical Note 1
API Limitations
When not explicitly specified, all resources exist from a base URL:
https://<server>/api/v1/evo/
<server> is the IP address (or DNS name when setup externally) of the NMS. All resources
below exist under an Evolution NMS node.
API Limitations
The following are some limitations with the iVantage API:
• The API does not support all network components.
• The API cannot read statistics and will not be able to replace SatManage monitoring.
• The user will not be able to use the API to create or modify service groups, bandwidth
groups, profiles, QoS, and so on.
• The API is executed as a single client and does not scale effectively for large numbers of
API calls.
• The API will be limited to the visibilities and permissions as the user defined in cxpd.cfg.
API Processes
There are two API processes that are needed to execute this API:
Table 1-1. API Processes
Process Name Description

Cxpd iDirect process that runs on the NMS and communicates
like iBuilder into the NMS processes.
NOTE: Ensure that the username/password
credentials and IP addresses are configured in
/etc/cxpd.cfg.
Node Node.js is a javascript server side engine that provides
the web services functionality.
Configuring the API Services

To configure the API, perform the following:
1. Ensure to back up and install the new nmssvr_e.lic under home/nms/cfg/nmssvr_e.lic.
2. Edit the /etc/cxpd.cfg file. Set the NMS server IP and the NMS Username and Password
to access iBuilder.
NOTE: Step 3 is only performed when the user is setting up a URL for Swagger
access.
2 Technical Note
Authentication
3. Edit the default.yaml file on the host. For example, /opt/NodeNMS/swagger-

editor/spec-files/default.yaml. By default, the host will be host: nodenms_server.
4. (Optional) Edit the windows host file (C:\Windows\System32\drivers\etc\host) to resolve
the host issue in the yaml file from Step 2.
5. Create cert (or add your own), execute the following command:
cd /opt/NodeNMS; /opt/NodeNMS/createcert.sh
NOTE: The files nodenms_server.[cert,key] must be present in /opt/NodeNMS or node
server will fail to start.
Authentication
HTTP Basic Access Authentication
The standard HTTP Basic Access Authentication is supported and is the preferred mechanism
of user authorization keeping with the RESTful philosophy of a stateless web server. Each
individual HTTP request contains the Authorization HTTP header and the server does not store
any client state.
User credentials are passed with each request using standard Basic Access Authentication;
which is an HTTP header in the following form:
Authorization: Basic <Base64(user:password)>
The following is an example of an actual authorization header:
Authorization: Basic YWRtaW46bXlzZWNyZXRwYXNzd29yZA==
NOTE: The Base64 encoding is not intended to provide any security, but
rather is used to avoid character encoding issues and escape sequences within
the user name or password.
The following is an example of an HTTP request utilizing the HTTP Basic Access
Authentication mechanism:
GET /api/1.0/resource HTTP/1.1
Authorization: Basic YWRtaW46cGFzc3dvcmQ=
Accept: application/json
Content-Type: application/json
Content-Length: 23
{
"JSON": "body"
}
Technical Note 3
Authentication
Session Cookie Authentication

A HTTP cookie-based authentication mechanism is also supported. With this authorization
approach, independent requests are made to login and obtain a session cookie, and then
logout when the session is no longer needed. Each subsequent request must contain the
session cookie obtained during log in.
Logging In
Each login request must contain a user name and password as HTTP form fields. A successful
login will contain a session cookie in an HTTP response header. A login request may also
optionally contain redirection URLs upon successful or failed login.
The following is an example of a successful login that redirects to a URL /success.html:
POST
/authorize?user=admin&password=iDirect&success=/success.html&fail=
/fail.html HTTP/1.1
HTTP/1.1 302 Found

Set-Cookie: session=9c099bc9165f0c7312f72b02e89253c2; http-only
Location: /success.html
Content-Length: 0
The following is an example of a failed login that redirects to a URL /fail.html:
POST
/authorize?user=admin&password=wrong&success=/success.html&fail=/f
ail.html HTTP/1.1
HTTP/1.1 302 Found

Location: /fail.html
Content-Length: 0
The following is an example of a successful login that redirects to the default URL:
POST /authorize?user=admin&password=iDirect HTTP/1.1
HTTP/1.1 302 Found

Set-Cookie: session=09a268c95e3d21d64c8bc351f84bacc6; http-only
Location: /
Content-Length: 0
The following is an example of a failed login that redirects to the default URL /login.html:
POST /authorize?user=admin&password=wrong HTTP/1.1
HTTP/1.1 302 Found
4 Technical Note
Authentication
Location: /login.html
Content-Length: 0
The following is an example of a successful login that does not redirect to any other page but
simply contains the session cookie:
POST /authorize?user=admin&password=iDirect&success=&fail=
HTTP/1.1
HTTP/1.1 200 OK
Set-Cookie: session=8df914a9b578973208b1283087561e0d; http-only
Content-Length: 5
Login
The following is an example of a failed login that does not redirect to any other page but
simply indicates an error:
POST /authorize?user=admin&password=wrong&success=&fail= HTTP/1.1
HTTP/1.1 401 Unauthorized

Content-Length: 0
Session Cookie Use

Each subsequent request must contain the session cookie as an HTTP header. The following is
an example HTTP request utilizing the session cookie authentication mechanism:
GET /api/1.0/resource HTTP/1.1
Cookie: session=8df914a9b578973208b1283087561e0d
Accept: application/json
Content-Type: application/json
Content-Length: 23
{
"JSON": "body"
}
Logging Out
Sessions are automatically logged out after a period of inactivity but it is good practice to
logout from the session explicitly. A logout request must contain a logout form field and the
session cookie in an HTTP request header. A logout request may also optionally contain a
redirection URL. The following is an example of a logout request that redirects to a URL
/logged-out.html:
Technical Note 5
Examples
POST /authorize?logout&success=/logged-out.html HTTP/1.1

HTTP/1.1 302 Found

Set-Cookie: session=; Max-Age=0
Location: /logged-out.html
Content-Length: 0
The following is an example of a logout request that redirects to the default URL /login.html:
POST /authorize?logout HTTP/1.1
HTTP/1.1 302 Found

Location: /login.html
Content-Length: 0
The following is an example of a logout request that does not redirect to any other page but
simply deletes the session cookie:
POST /authorize?logout&success= HTTP/1.1
HTTP/1.1 200 OK
Content-Length: 6
Logout
Session Timeout
It is good practice to always logout of a session when it is no longer needed. A session will
expire after a period of inactivity; however, this is a contingency and session expiry should not
be relied upon for normal operation. When a session is intended for a long period with
infrequent use, insert a dummy requests during periods of inactivity to keep the session alive
and prevent it from expiring.
Examples
Use the following sample curl commands to login to NMS and GET, POST, or PATCH any object
through the API.
6 Technical Note
Examples
GET:
GET retrieves leight-weight information about the requested VSAT terminal. This does not
include the Customer information. Please use api/diagnostic to get the Vsat plus Customer
information.
http(s)://<server IP[:PORT]>/v1/vsat/<ID>/<ATTRIBUTE>
example Call
curl -s -k -u admin:admin -iX GET
https://127.0.0.1:443/api/v1/evo/config/obj/remote/8
example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 09 Aug 2015 21:53:38 GMT
Connection: keep-alive
Transfer-Encoding: chunked
{ "Name" : "Remote AT HQ (8)" }
example Call 2
example response 2
HTTP/1.1 200 OK
Date: Sun, 012 Sep 2015 13:09:59 GMT
{
"ID": "8",
"Name": "Remote AT HQ (8)",
"SN": "106882",
"DID": "234987906",
"ModelType": "X1",
"InrouteGroupID": "6",
"NetworkID": "2",
"Active": "0",
"MgmtIPAddress": "10.8.0.2",
"MgmtSubnetMask": "255.255.248.0",
"MgmtGateway": "127.0.0.1",
"LanIPAddress": "192.168.85.129",
Technical Note 7
Examples
"LanSubnetMask": "255.255.255.252",
"LanGateway": "127.0.0.1",
"RXCarrierID": "4294967295",
"TXCarrierID": "4294967295",
"TXPower": "-15",
"Lat": "-26.24828",
"Lon": "28.18183",
"TCPCompression": "0",
"UDPHdrCompression": "0",
"UDPCompression": "0",
"LinkEncryption": "0",
"CRTP": "0",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"AntennaID": "4",
"AntennaTxHandshake": "0",
"IsMobile": "0",
"IsSCPC": "0",
"SCPCPeerID": "0",
"IsRoaming": "0",
"SymbolRate": "459",
"MODCOD": "QPSK3/4",
"InitialPower": "-15",
"MaxPower": "-5",
"SpreadingFactor": "0",
"PayloadSize": "0",
"1DB": "-4"
}
example Call 3
curl -i -X GET ' http://192.168 . 1.10/v1/vsat'
example response 3
HTTP/1.1 200 OK
Date: Mon, 10 Aug 2015 00:13:46 GMT
8 Technical Note
Examples
[
{
"Name": "Remote #8",
"ID": "8",
"DID": "234987906",
"NetworkID": "2",
"LinecardID": "0"
},
{
"ID": "10",
"DID": "234987911",
"NetworkID": "2",
"LinecardID": "0"
},
{
"ID": "908",
"DID": "235021302",
"NetworkID": "2",
"LinecardID": "0"
},
{
"ID": "909",
"DID": "235004748",
"NetworkID": "2",
"LinecardID": "0"
}
]
Technical Note 9
Examples
POST:
POST Creates a new VSAT instance in the iVantage system. With this call you will not be able
to specify the Customer information. For this please use the api/diagnostic – API.
http(s)://<server IP[:PORT]>/v1/vsat
example Call
curl -H "Content-Type: application/json" -i -X POST -d '{
"Name": "New VSat Terminal",
"SN": "106887",
"ModelType": "X1",
"NetworkID": "1",
"Active": "1",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"IsMobile": "0",
"TXPower": "-15",
"Lat": "-26.24828",
"Lon": "28.18183",
"MaxPower": "-5",
"ID": null,
"DID": null,
"MgmtIPAddress": null,
"MgmtSubnetMask": null,
"MgmtGateway": null,
"LanIPAddress": null,
"LanSubnetMask": null,
"LanGateway": null,
"RXCarrierID": null,
"TXCarrierID": null,
"TCPCompression": null,
"UDPHdrCompression": null,
"UDPCompression": null,
10 Technical Note
Examples
"LinkEncryption": null,
"CRTP": null,
"AntennaID": null,
"AntennaTxHandshake": null,
"IsSCPC": null,
"SCPCPeerID": null,
"IsRoaming": null,
"SpreadingFactor": null,
"PayloadSize": null,
"1DB": null
}' http://192.168 . 1.10/v1/vsat
example Response
HTTP/1.1 200 OK
Date: Sat, 12 Sep 2015 14:31:26 GMT
{
"ID": "80",
"Name": "New VSat Terminal",
"SN": "106887",
"DID": "234987912",
"ModelType": "X1",
"NetworkID": "1",
"Active": "1",
"MgmtIPAddress": "null",
"MgmtSubnetMask": "null",
"MgmtGateway": "null",
"LanIPAddress": "null",
"LanSubnetMask": "null",
"LanGateway": "null",
"RXCarrierID": "4294967295",
"TXCarrierID": "3",
"TXPower": "-15",
"Lat": "0",
"Lon": "0",
Technical Note 11
Examples
"CRTP": "0",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"AntennaID": "0",
"IsMobile": "0",
"IsSCPC": "0",
"SCPCPeerID": "0",
"IsRoaming": "0",
"MaxPower": "-5",
"PayloadSize": "0",
"1DB": "0"
}
PATCH:
PATCH Updates a set of attributes of the VSAT terminal. The collection of the provided
attributes does not need to be complete. With this call you will not be able to specify the
Customer information. For this please use the api/diagnostic – API.
http(s)://<server IP[:PORT]>/v1/vsat/<ID>/<ATTRIBUTE>/<VALUE>
example Call
example response
HTTP/1.1 200 OK
Date: Sat, 12 Sep 2015 16:45:55 GMT
12 Technical Note
Examples
{ "Name" : "Renamed Name" }

example Call 2
curl -H "Content-Type: application/json" -i -X PATCH -d '{
"Name": "Vsat Name",
"LanIPAddress": "10.50.20.10",
"LanSubnetMask": "255.255.255.0",
"LanGateway": "10.50.20.1"
}' http://192.168 . 1 .10/v1/vsat /8
example response 2
HTTP/1.1 200 OK
Date: Sun, 13 Sep 2015 00:40:47 GMT
{
"ID": "8",
"Name": "Vsat Name",
"Status": "",
"SN": "126343",
"DID": "235007367",
"ModelType": "X1",
"NetworkID": "2",
"Active": "1",
"MgmtIPAddress": "10.8.4.254",
"MgmtSubnetMask": "255.255.255.252",
"MgmtGateway": "127.0.0.1",
"LanIPAddress": "10.50.20.10",
"LanSubnetMask": "255.255.255.0",
"LanGateway": "10.50.20.1",
"RXCarrierID": "4294967295",
"TXCarrierID": "4294967295",
"TXPower": "-14",
"Lat": "-29.85694",
"Lon": "31.01722",
Technical Note 13
Examples
"CRTP": "0",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"AntennaID": "1316",
"IsMobile": "0",
"IsSCPC": "0",
"SCPCPeerID": "0",
"IsRoaming": "0",
"InitialPower": "14",
"MaxPower": "5",
"PayloadSize": "1",
"1DB": "-4"
}
DELETE:
DELETE removes a VSAT terminal from the iVantage NMS. Please be advised that once the
terminal is deleted you will no longer be able to recover it.
http(s)://<server IP[:PORT]>/v1/vsat/<ID>
example Call
curl -s -k -u admin:admin -iX DELETE
example response
HTTP/1.1 200 OK
Date: Fri, 21 Aug 2015 23:07:47 GMT
14 Technical Note
iVantage API
Overview
This is the iDirect iVantage API.
Version information
Version : 1.0.0
URI scheme
Host : nodenms_server
BasePath : /api/v1/evo/config/obj
Schemes : HTTPS, HTTP
Consumes
• application/json
• text/xml
Produces
• application/json
• text/html
Paths
GET /applicationservicegroup
Description
List all applicationservicegroups
Responses
HTTP Code Description Schema

ApplicationServ
200 List all applicationservicegroups iceGroupListRes
ponse
500 Server Error Errors
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET
/applicationservicegroup/{applicationservicegroupId}
Description
Returns the applicationservicegroup with ID = applicationservicegroupId
Parameters
Type Name Description Schema Default

applicationserv
Path icegroupId ID of the applicationservicegroup integer
required
Responses

ApplicationServ
Returns the applicationservicegroup with ID =
200 iceGroupRespo
applicationservicegroupId
nse
404 Not Found No Content
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH
/applicationservicegroup/{applicationservicegroupId}
Description
Updates the applicationservicegroup and returns the updated applicationservicegroup. Note:

this only requires a partial list of properties
Parameters

applicationserv
Path icegroupId ID of the applicationservicegroup integer
required
ApplicationSer The applicationservicegroup JSON
ApplicationServi
Body viceGroup you want to update the
ceGroup
required applicationservicegroup with
Responses

ApplicationServ
200 Returns the updated applicationservicegroup iceGroupRespo
nse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /authorize
Description
Login user and receive a session token in the header, or Logout existing session token.
Parameters

Location to redirect to upon failed
Query fail string
login or logout
If included will logout and delete
Query logout string
session
password
Query The password of the user string
required
Location to redirect to upon
Query success string
successful login or logout
user
Query The username of the user string
required
Responses

200 Success string
Redirect to success parameter on success or fail parameter on
302 No Content
fail
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /buc
Description
List all bucs
Responses

BUCListRespons
200 List all bucs
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /buc/{bucId}
Description
Returns the buc with ID = bucId
Parameters

bucId
Path ID of the buc integer
required
Responses

200 Returns the buc with ID = bucId BUCResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /carrier
Description
Creates the Carrier
Parameters

Carrier
Body The carrier JSON you want to post Carrier
required
Responses

CarrierRespons
201 Creates the Carrier and returns it
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /carrier
Description
List all carriers
Responses

CarrierListResp
200 List all carriers
onse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /carrier/{carrierId}
Description
Returns the carrier with ID = carrierId
Parameters

carrierId
Path ID of the carrier integer
required
Responses

CarrierRespons
200 Returns the carrier with ID = carrierId
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /carrier/{carrierId}
Description
Deletes the carrier with ID = carrierId
Parameters

carrierId
required
Responses

204 No content No Content
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /carrier/{carrierId}
Description
Updates the carrier and returns the updated carrier. Note: this only requires a partial list of
properties
Parameters

carrierId
required
Carrier The carrier JSON you want to
Body Carrier
required update the carrier with
Responses

CarrierRespons
200 Returns the updated carrier
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /downconverter
Description
Creates the DownConverter
Parameters

DownConverter The downconverter JSON you want
Body DownConverter
required to post
Responses

DownConverter
201 Creates the DownConverter and returns it
Response
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /downconverter
Description
List all downconverters
Responses

DownConverter
200 List all downconverters
ListResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /downconverter/{downconverterId}
Description
Returns the downconverter with ID = downconverterId
Parameters

downconverter
Path Id ID of the downconverter integer
required
Responses

DownConverter
200 Returns the downconverter with ID = downconverterId
Response
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /downconverter/{downconverterId}
Description
Deletes the downconverter with ID = downconverterId
Parameters

downconverter
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /downconverter/{downconverterId}
Description
Updates the downconverter and returns the updated downconverter. Note: this only requires
a partial list of properties
Parameters

downconverter
required
DownConverter The downconverter JSON you want
Body DownConverter
required to update the downconverter with
Responses

DownConverter
200 Returns the updated downconverter
Response
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /hubrft
Description
Creates the HubRFT
Parameters

HubRFT
Body The hubrft JSON you want to post HubRFT
required
Responses

HubRFTRespon
201 Creates the HubRFT and returns it
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /hubrft
Description
List all hubrfts
Responses

HubRFTListRes
200 List all hubrfts
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /hubrft/{hubrftId}
Description
Returns the hubrft with ID = hubrftId
Parameters

hubrftId
Path ID of the hubrft integer
required
Responses

HubRFTRespon
200 Returns the hubrft with ID = hubrftId
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /hubrft/{hubrftId}
Description
Deletes the hubrft with ID = hubrftId
Parameters

hubrftId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /hubrft/{hubrftId}
Description
Updates the hubrft and returns the updated hubrft. Note: this only requires a partial list of
properties
Parameters

hubrftId
required
HubRFT The hubrft JSON you want to
Body HubRFT
required update the hubrft with
Responses

HubRFTRespon
200 Returns the updated hubrft
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /inroutegroup
Description
Creates the InrouteGroup
Parameters

InrouteGroup The inroutegroup JSON you want
Body InrouteGroup
required to post
Responses

InrouteGroupRe
201 Creates the InrouteGroup and returns it
sponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /inroutegroup
Description
List all inroutegroups
Responses

InrouteGroupLi
200 List all inroutegroups
stResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /inroutegroup/{inroutegroupId}
Description
Returns the inroutegroup with ID = inroutegroupId
Parameters

inroutegroupId
Path ID of the inroutegroup integer
required
Responses

InrouteGroupRe
200 Returns the inroutegroup with ID = inroutegroupId
sponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /inroutegroup/{inroutegroupId}
Description
Deletes the inroutegroup with ID = inroutegroupId
Parameters

inroutegroupId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /inroutegroup/{inroutegroupId}
Description
Updates the inroutegroup and returns the updated inroutegroup. Note: this only requires a
partial list of properties
Parameters

inroutegroupId
required
InrouteGroup The inroutegroup JSON you want
Body InrouteGroup
required to update the inroutegroup with
Responses

InrouteGroupRe
200 Returns the updated inroutegroup
sponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /linecard
Description
Creates the Linecard
Parameters

Linecard The linecard JSON you want to
Body Linecard
required post
Responses

LinecardRespon
201 Creates the Linecard and returns it
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /linecard
Description
List all linecards
Responses

LinecardRespon
200 List all linecards
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /linecard/{linecardId}
Description
Returns the linecard with ID = linecardId
Parameters

linecardId
Path ID of the linecard integer
required
Responses

LinecardRespon
200 Returns the linecard with ID = linecardId
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /linecard/{linecardId}
Description
Deletes the linecard with ID = linecardId
Parameters

linecardId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /linecard/{linecardId}
Description
Updates the linecard and returns the updated linecard. Note: this only requires a partial list of
properties
Parameters

linecardId
required
Linecard The linecard JSON you want to
Body Linecard
required update the linecard with
Responses

LinecardRespon
200 Returns the updated linecard
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /lnb
Description
List all lnbs
Responses

LNBListRespons
200 List all lnbs
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /lnb/{lnbId}
Description
Returns the lnb with ID = lnbId
Parameters

lnbId
Path ID of the lnb integer
required
Responses

200 Returns the lnb with ID = lnbId LNBResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /network
Description
Creates the Network
Parameters

Network The network JSON you want to
Body Network
required post
Responses

NetworkRespon
201 Creates the Network and returns it
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /network
Description
List all networks
Responses

NetworkListRes
200 List all networks
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /network/{networkId}
Description
Returns the network with ID = networkId
Parameters

networkId
Path ID of the network integer
required
Responses

NetworkRespon
200 Returns the network with ID = networkId
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /network/{networkId}
Description
Deletes the network with ID = networkId
Parameters

networkId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /network/{networkId}
Description
Updates the network and returns the updated network. Note: this only requires a partial list of
properties
Parameters

networkId
required
Network The network JSON you want to
Body Network
required update the network with
Responses

NetworkRespon
200 Returns the updated network
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /reflector
Description
List all reflectors
Responses

ReflectorListRes
200 List all reflectors
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /reflector/{reflectorId}
Description
Returns the reflector with ID = reflectorId
Parameters

reflectorId
Path ID of the reflector integer
required
Responses

ReflectorRespon
200 Returns the reflector with ID = reflectorId
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /remote
Description
Creates the Remote
Parameters

Remote
Body The remote JSON you want to post Remote
required
Responses

RemoteRespons
201 Creates the Remote and returns it
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /remote
Description
List all remotes
Parameters

A boolean flag indicating whether
Query Active to retrieve remotes that are active boolean
or inactive
The InrouteGroupID of the
Query DID integer
remotes you would like to match
The ID of the remote you would
Query ID integer
like to match
InrouteGroupI The InrouteGroupID of the
Query integer
D remotes you would like to match
A boolean flag indicating whether
Query IsSCPC to retrieve remotes using SCPC boolean
return
The model type of the remotes you
Query ModelType string
would like to match
The name or partial name of the
Query Name string
The NetworkID of the remotes you
Query NetworkID integer
would like to match
The ParentID of the remotes you
Query ParentID integer
would like to match
The InrouteGroupID of the
Query SCPCPeerID integer
The serial number of the remote
Query SN string
you would like to match
Responses

RemoteListResp
200 List all remotes
onse
Security
Type Name Scopes
basic basicAuth
apiKey cookieAuth
GET /remote/{remoteId}
Description
Returns the remote with ID = remoteId
Parameters

remoteId
Path ID of the remote integer
required
Responses

RemoteRespons
200 Returns the remote with ID = remoteId
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /remote/{remoteId}
Description
Deletes the remote with ID = remoteId
Parameters

remoteId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}
Description
Updates the remote and returns the updated remote. Note: this only requires a partial list of
properties
Parameters

remoteId
required
Remote The remote JSON you want to
Body Remote
required update the remote with
Responses

RemoteRespons
200 Returns the updated remote
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /remote/{remoteId}/add_roaming_instance
Description
Create a Roaming Instance of a Remote
Parameters

remoteId The id of the remote to send the
Path integer
required probe command to.
Remote The roaming remote JSON you
Body RoamingRemote
required want to post
Responses

RemoteRespons
201 Created
e
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}/apply_changes
Description
Apply Configuration Changes
Parameters

remoteId The id of the remote to apply
Path integer
required changes to.
parameters The settings JSON you want to use. ApplyChangesRe
Body
required Transport can be udp or tcp. quest
Responses

ApplyChangesR
202 Accepted
esponse
405 Method Not Allowed string
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /remote/{remoteId}/raw_optionsfile
Description
Retrieve Options Files for the remote
Parameters

remoteId The id of the remote to retrieve the
Path integer
required options file for.
The type of options file, HubSide or
Query type string
RmtSide.
The version of options file, Active
Query version string
or Saved.
Responses

200 Success string
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}/reset
Description
Send a remote probe command to the Remote with the given ID commanding it to perform a
software reset.
Parameters

Path integer
required stop command to.
Responses

202 Accepted No Content
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /remote/{remoteId}/status
Description
Query Configuration State
Parameters

remoteId The id of the remote to check the
Path integer
required status of.
Responses

200 Success StatusResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}/stop_cw_pn
Description
Send a remote probe command to the Remote with the given ID commanding it to stop
transmission of either a CW or a PN carrier..
Parameters

Path integer
required stop command to.
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}/tx_cw
Description
Send a remote probe command to the Remote with the given ID commanding it to transmit a CW.
Can be reissued with same parameters but with a different transmit power in order to adjust
transmit power of a CW.
Parameters

Path integer
cw The CW settings JSON you want to
Body CW
required use for the command.
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remote/{remoteId}/tx_pn
Description
Send a remote probe command to the Remote with the given ID commanding it to transmit a PN
carrier. Can be reissued with same parameters but with a different transmit power in order to
adjust transmit power of the carrier.
Parameters

Path integer
The PN settings JSON you want to
pn use for the command. Type
Body PN
required Modulation values can be 8PSK,
QPSK or BPSK.
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /remoteservicegroup
Description
List all remoteservicegroups
Responses

RemoteServiceG
200 List all remoteservicegroups roupListRespon
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /remoteservicegroup/{remoteservicegroupId}
Description
Returns the remoteservicegroup with ID = remoteservicegroupId
Parameters

remoteserviceg
Path roupId ID of the remoteservicegroup integer
required
Responses

Returns the remoteservicegroup with ID = RemoteServiceG
200
remoteservicegroupId roupResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /remoteservicegroup/{remoteservicegroupId}
Description
Updates the remoteservicegroup and returns the updated remoteservicegroup. Note: this only
requires a partial list of properties
Parameters

remoteserviceg
Path roupId ID of the remoteservicegroup integer
required
RemoteService The remoteservicegroup JSON you
RemoteServiceG
Body Group want to update the
roup
required remoteservicegroup with
Responses

RemoteServiceG
200 Returns the updated remoteservicegroup
roupResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /spacecraft
Description
Creates the Spacecraft
Parameters

Spacecraft The spacecraft JSON you want to
Body Spacecraft
required post
Responses

SpacecraftResp
201 Creates the Spacecraft and returns it
onse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /spacecraft
Description
List all spacecrafts
Responses

SpacecraftListR
200 List all spacecrafts
esponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /spacecraft/{spacecraftId}
Description
Returns the spacecraft with ID = spacecraftId
Parameters

spacecraftId
Path ID of the spacecraft integer
required
Responses

SpacecraftResp
200 Returns the spacecraft with ID = spacecraftId
onse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /spacecraft/{spacecraftId}
Description
Deletes the spacecraft with ID = spacecraftId
Parameters

spacecraftId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /spacecraft/{spacecraftId}
Description
Updates the spacecraft and returns the updated spacecraft. Note: this only requires a partial
list of properties
Parameters

spacecraftId
required
Spacecraft The spacecraft JSON you want to
Body Spacecraft
required update the spacecraft with
Responses

SpacecraftResp
200 Returns the updated spacecraft
onse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /teleport
Description
Creates the Teleport
Parameters

Teleport
Body The teleport JSON you want to post Teleport
required
Responses

TeleportRespon
201 Creates the Teleport and returns it
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /teleport
Description
List all teleports
Responses

TeleportListRes
200 List all teleports
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /teleport/{teleportId}
Description
Returns the teleport with ID = teleportId
Parameters

teleportId
Path ID of the teleport integer
required
Responses

TeleportRespon
200 Returns the teleport with ID = teleportId
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /teleport/{teleportId}
Description
Deletes the teleport with ID = teleportId
Parameters

teleportId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /teleport/{teleportId}
Description
Updates the teleport and returns the updated teleport. Note: this only requires a partial list of
properties
Parameters

teleportId
required
Teleport The teleport JSON you want to
Body Teleport
required update the teleport with
Responses

TeleportRespon
200 Returns the updated teleport
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /upconverter
Description
Creates the UpConverter
Parameters

UpConverter The upconverter JSON you want to
Body UpConverter
required post
Responses

UpConverterRes
201 Creates the UpConverter and returns it
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /upconverter
Description
List all upconverters
Responses

UpConverterLis
200 List all upconverters
tResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /upconverter/{upconverterId}
Description
Returns the upconverter with ID = upconverterId
Parameters

upconverterId
Path ID of the upconverter integer
required
Responses

UpConverterRes
200 Returns the upconverter with ID = upconverterId
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
DELETE /upconverter/{upconverterId}
Description
Deletes the upconverter with ID = upconverterId
Parameters

upconverterId
required
Responses

Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /upconverter/{upconverterId}
Description
Updates the upconverter and returns the updated upconverter. Note: this only requires a
partial list of properties
Parameters

upconverterId
required
UpConverter The upconverter JSON you want to
Body UpConverter
required update the upconverter with
Responses

UpConverterRes
200 Returns the updated upconverter
ponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
POST /user
Description
Creates the User
Parameters

User
Body The user JSON you want to post User
required
Responses

201 Creates the User and returns it UserResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /user
Description
List all users
Responses

UserListRespon
200 List all users
se
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
GET /user/{userId}
Description
Returns the user with ID = userId
Parameters

userId
Path ID of the user integer
required
Responses

200 Returns the user with ID = userId UserResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
PATCH /user/{userId}
Description
Updates the user and returns the updated user. Note: this only requires a partial list of
properties
Parameters

userId
Path ID of the user integer
required
User The user JSON you want to update
Body User
required the user with
Responses

200 Returns the updated user UserResponse
Security
Type Name Scopes

basic basicAuth
apiKey cookieAuth
Definitions
AggregateAddress
Name Schema
AFI string
AdvertiseMapNumber integer(int32)
AggregateAddressNumber integer(int32)
AttributeMapNumber integer(int32)
Option string
PrefixAddr string
PrefixLen integer(int32)
SAFI string
SuppressMapNumber integer(int32)
ApplicationMember
Name Schema
ApplicationID integer(int32)
ApplicationName string
ApplicationServiceGroup
Name Description Schema
AllocRelToCIR boolean
AllocRelToNominal boolean
AllocRelToOperationa
boolean
l
< ApplicationMember >
Applications
array
ConfiguredRates ConfiguredRates
Downstream boolean
EffectiveRates EffectiveRates
EnableEIR boolean
ID Internal ID of the ApplicationServiceGroup integer
MinMODCOD string
Name Name of the ApplicationServiceGroup string
ParentID integer(int32)
ParentName string
Priority string
StickyCIR boolean
ConfiguredRates
Name Schema
CIRkbps number(double)
Cost number(double)
EnableCIR boolean
EnableMIR boolean
MIRkbps number(double)
EffectiveRates
Name Schema
CirModcodTable CirModcodTable
Cost number(double)
MirModcodTable MirModcodTable
CirModcodTable
Name Schema
MC_16APSK_2_3 number(double)
MC_8PSK_2_3 number(double)
MC_QPSK_1_2 number(double)
MirModcodTable
Name Schema
ApplicationServiceGroupListItem
Name Schema
Downstream boolean
ID integer(int32)
Name string
ParentName string
QOSGroupType string
QOSMode string
ApplicationServiceGroupListResponse
Name Schema
data < ApplicationServiceGroupListItem > array
errors Errors
meta Meta
ApplicationServiceGroupResponse
Name Schema
data ApplicationServiceGroup
errors Errors
meta Meta
ApplyChanges
Name Schema
Success string
ApplyChangesRequest
Name Schema
HubSide boolean
Reset boolean
Transport string
ApplyChangesResponse
Name Schema
data ApplyChanges
BUC
Gain number(double)
ID Internal ID of the BUC integer
Manufacturer string
Name Name of the BUC string
Power number(double)
SpectralInversion string
StartFreq number(double)
StopFreq number(double)
TranslationFreq number(double)
TxDcEnable boolean
TxRefOscillator string
iDirectPartNumber string
BUCListItem
Name Schema
ID integer(int32)
Name string
BUCListResponse
Name Schema
data < BUCListItem > array
errors Errors
meta Meta
BUCResponse
Name Schema
data BUC
errors Errors
meta Meta
CW
Name Schema
BUCLOFreq number
RFUplink number
TXPower number
Carrier
BandwidthID integer(int32)
CarrierSpacing number(double)
DownlinkFreq number(double)
FecRate string
ID Internal ID of the Carrier integer
InboundMode string
MaxModcod string
MinModcod string
ModulationType string
Name Name of the Carrier string
Power number(double)
SpacecraftID integer(int32)
SpreadAcqEnabled boolean
SpreadingFactor string
Superburst boolean
SymbolRate number(double)
TransponderID integer(int32)
Type string
UplinkFreq number(double)
CarrierListItem
Name Schema
ID integer(int32)
Name string
CarrierListResponse
Name Schema
data < CarrierListItem > array
errors Errors
meta Meta
CarrierResponse
Name Schema
data Carrier
errors Errors
meta Meta
Composition
Name Schema
ID integer(int32)
ModcodForEachCarrier < string > array
Name string
ConfigTables
Name Schema
AdvertiseMapNumber integer(int32)
ConfigTableNumber integer(int32)
ExportMapNumber integer(int32)
ImportMapNumber integer(int32)
NonExistMapNumber integer(int32)
DiscretePort
Name Schema
Duplex string
Enabled boolean
Mode string
NativeVLanID string
PortEthertype1 string
PortEthertype2 string
PortNumber integer(int32)
Speed string
SvnIDs < string > array
DownConverter
ID Internal ID of the DownConverter integer
ManufacturerID integer(int32)
ManufacturerPN string
Name Name of the DownConverter string
ODURx10MHz boolean
ODURxDCPower boolean
Stability number(double)
iDirectPN string
DownConverterListItem
Name Schema
ID integer(int32)
Name string
DownConverterListResponse
Name Schema
data < DownConverterListItem > array
errors Errors
meta Meta
DownConverterResponse
Name Schema
data DownConverter
errors Errors
meta Meta
ElevationGain
Name Schema
Elevation integer(int32)
Gain number(double)
Error
Name Schema
Message string
Errors
Type : < Error > array
GreTunnel
Name Schema
HubGateway string
RemoteGateway string
HubRFT
AntennaID integer(int32)
DownConverterID integer(int32)
HPAID integer(int32)
ID Internal ID of the HubRFT integer
Name Name of the HubRFT string
TeleportID integer(int32)
UpConverterID integer(int32)
HubRFTListItem
Name Schema
ID integer(int32)
Name string
HubRFTListResponse
Name Schema
data < HubRFTListItem > array
errors Errors
meta Meta
HubRFTResponse
Name Schema
data HubRFT
errors Errors
meta Meta
InrouteGroup
Adaptive Adaptive
BandwidthGroupIDs < integer(int32) > array
CarrierIDs < integer(int32) > array
Compositions < Composition > array
ID Internal ID of the InrouteGroup integer
MaxCotmSpeed integer(int32)
Mesh Mesh
Name Name of the InrouteGroup string
NetworkID integer(int32)
QosMode string
Timeplan Timeplan
Adaptive
Name Schema
AllowedDropoutFraction integer(int32)
DefaultIgcID integer(int32)
FixedIgcID integer(int32)
UpdateInterval integer(int32)
Mesh
Name Schema
MeshEnabled boolean
TxMargin number(double)
VLansEnabled boolean
Timeplan
Name Schema
AcqAperture number(double)
GuardInterval integer(int32)
InrouteGroupListItem
Name Schema
ID integer(int32)
Name string
InrouteGroupListResponse
Name Schema
data < InrouteGroupListItem > array
errors Errors
meta Meta
InrouteGroupResponse
Name Schema
data InrouteGroup
errors Errors
meta Meta
LNB
22KhzEnable boolean
Gain number(double)
ID Internal ID of the LNB integer
Manufacturer string
Name Name of the LNB string
NoiseFigure number(double)
Rx10MHzEnable boolean
RxDcEnable boolean
RxDcVoltage string
StartFreq number(double)
StopFreq number(double)
LNBListItem
Name Schema
ID integer(int32)
Name string
LNBListResponse
Name Schema
data < LNBListItem > array
errors Errors
meta Meta
LNBResponse
Name Schema
data LNB
errors Errors
meta Meta
Linecard
Active boolean
AdminPassword string
AltTxCarrierID integer(int32)
ChassisID integer(int32)
DID integer(int64)
GIG0Gateway string
GIG0IPAddress string
GIG0Speed string
GIG0SubnetMask string
HubRFTID integer(int32)
ID Internal ID of the Linecard integer
LinecardType string
MgmtGateway string
MgmtIPAddress string
MgmtSubnetMask string
ModelType string
Name Name of the Linecard string
RXCarrierIds < RXCarrier > array
ReceiveMode string
RxCenterFreq number(double)
SN integer(int64)
TxCarrierID integer(int32)
UserPassword string
LinecardResponse
Name Schema
data Linecard
errors Errors
meta Meta
MCGroup
Name Schema
Address string
ID integer(int32)
VLanID integer(int32)
Meta
Name Schema
Count integer(int32)
MulticastGroup
Name Schema
Address string
Interface string
Network
ID Internal ID of the Network integer
MulticastGroups < MCGroup > array
Name Name of the Network string
ProtocolProcessorID integer(int32)
NetworkListItem
Name Schema
ID integer(int32)
Name string
NetworkListResponse
Name Schema
data < NetworkListItem > array
errors Errors
meta Meta
NetworkResponse
Name Schema
data Network
errors Errors
meta Meta
PN
Name Schema
BUCLOFreq number
Modulation string
RFUplink number
SymbolRate number
TXPower number
PeerGroups
Name Schema
Aggregate boolean
Area string
NextHopSelf boolean
PeerGroupNumber integer(int32)
Peers
Name Schema
ConnectRetry integer(int32)
DropWarn string
HoldTime integer(int32)
IsReflectorClient boolean
KeepAlive integer(int32)
MD5AuthPassword string
MaxRoutesPeer integer(int32)
NextHopSelf boolean
Passive boolean
PeerGroupNumber integer(int32)
PeerNumber integer(int32)
RemoteAS integer(int32)
RemoteAddr string
RemotePort integer(int32)
PortForward
Name Schema
IPAddress string
PortFirst integer(int32)
PortLast integer(int32)
Protocol string
RXCarrier
Name Schema
ID integer(int32)
Name string
Reflector
AntennaController AntennaController
Controllable boolean
ID Internal ID of the Reflector integer
Name Name of the Reflector string
OffsetAngle number(double)
Size number(double)
AntennaController
Name Schema
ControllerType string
ElevationGain < ElevationGain > array
SkewGain < SkewGain > array
ReflectorListItem
Name Schema
ID integer(int32)
Name string
ReflectorListResponse
Name Schema
data < ReflectorListItem > array
errors Errors
meta Meta
ReflectorResponse
Name Schema
data Reflector
errors Errors
meta Meta
Remote
1DB number(double)
Active boolean
AdminPassword string
AllowBGP boolean
AntennaComponents AntennaComponents
AntennaTxHandshake boolean
CRTP boolean
CustomKeys CustomKeys
Customer Customer
DID integer(int64)
DisableTxPWM boolean
DiscretePorts < DiscretePort > array
DownCIR number(double)
DownMIN number(double)
DownMIR number(double)
ID Internal ID of the Remote integer
InitialPower number(double)
InrouteGroupID integer(int32)
IsMobile boolean
IsRoaming boolean
IsSCPC boolean
L2oS L2oS
LanGateway string
LanIPAddress string
LanSubnetMask string
Lat number(double)
LinkEncryption boolean
LocalTelnetOnly boolean
Lon number(double)
MODCOD string
MaxPower number(double)
Mesh Mesh
MgmtGateway string
MgmtIPAddress string
MgmtSubnetMask string
Mobile Mobile
ModelType string
Name Name of the Remote string
OSPassword string
PayloadSize integer(int32)
PoolLicense < string > array
RXCarrierID integer(int32)
RemoteQOS RemoteQOS
< RoamingInstance >
RoamingInstances
array
RxOnly boolean
RxOnlyMCTimeout integer(int32)
RxOnlyMulticast boolean
SCPCPeerID integer(int64)
SN integer(int64)
SpreadingFactor integer(int32)
SwitchPorts < SwitchPort > array
SymbolRate number(double)
TCPCompression boolean
TXCarrierID integer(int32)
TXPower number(double)
UDPCompression boolean
UDPHdrCompression boolean
UpCIR number(double)
UpMIN number(double)
UpMIR number(double)
UserPassword string
VLanTagging boolean
VLans < VLanInfo > array
AntennaComponents
Name Schema
Address string
ApproxCableLength integer(int32)
BUCID integer(int32)
BoostLnbVoltage boolean
ConnectTimeout integer(int32)
HuntFreq number(double)
HuntFreqSelect string
InitTXPowerOffset number(double)
LNBIDs < integer(int32) > array
NoiseRefFreq number(double)
OpenAMIPAntennaController OpenAMIPAntennaController
OrbitSBCAntennaController OrbitSBCAntennaController
Port integer(int32)
RXPolarisation string
ReflectorID integer(int32)
SeaTelDACAntennaController SeaTelDACAntennaController
TXPolarisation string
OpenAMIPAntennaController
Name Schema
HuntBandwidth number(double)
RxLocalOscillator number(double)
TxBandwidth number(double)
TxFreq number(double)
TxLocalOscillator number(double)
OrbitSBCAntennaController
Name Schema
Enable22KhzTone boolean
LNBVoltage integer(int32)
SeaTelDACAntennaController
Name Schema
DVB_FEC number(double)
Enable22KhzTone boolean
EnableDAC97 boolean
LNBVoltage integer(int32)
NID string
CustomKeys
Name Schema
HubSide string
RemoteSide string
Customer
Name Schema
CommissionDate string
ContractNumber string
Name string
Phone string
SiteNotes string
L2oS
Name Schema
BFD boolean
Compression integer(int32)
Ethertype1 string
Ethertype2 string
MTU integer(int32)
SDT integer(int32)
SVNs < SVN > array
Mesh
Name Schema
Mode string
ReceiverFadeMargin number(double)
ReceiverHysteresisMargin number(double)
ReceiverIPAddress string
ReceiverSN integer(int64)
ReceiverSubnetMask string
Mobile
Name Schema
COTMType string
GPSInput string
GPSRefreshRate integer(int32)
Handshake boolean
MaxSkew number(double)
MinLookAngle number(double)
Security boolean
SerialDevice string
SerialSettings string
SkewMargin number(double)
RemoteQOS
Name Schema
DSAllocRelToCIR boolean
DSDistributor DSDistributor
DSQOS DSQOS
DSRateShaping DSRateShaping
IdleDormant IdleDormant
MaxMODCOD string
NominalMODCOD string
USAdaptive USAdaptive
USAllocRelToCIR boolean
USDistributor USDistributor
USQOS USQOS
USRateShaping USRateShaping
DSDistributor
Name Schema
Enabled boolean
SegmentSize integer(int32)
DSQOS
Name Schema
FilterProfile string
FilterProfileID integer(int32)
MCServiceProfile string
MCServiceProfileID integer(int32)
QOSGroupType string
ServiceGroup string
ServiceGroupID integer(int32)
ServiceProfile string
ServiceProfileID integer(int32)
DSRateShaping
Name Schema
CIR number(double)
Cost number(double)
EnableCIR boolean
EnableEIR boolean
EnableMaxIR boolean
EnableMinIR boolean
MaxIR number(double)
MinIR number(double)
MinMODCOD string
Priority string
IdleDormant
Name Schema
DormantSlotsEvery integer(int32)
DormantTimeout integer(int32)
Enabled boolean
IdleSTimeout integer(int32)
IdleSlotsEvery integer(int32)
USAdaptive
Name Schema
EnableMaxImpairment boolean
MaxCN number(double)
MaxImpairment number(double)
MaxSymrate number(double)
USDistributor
Name Schema
Enabled boolean
SegmentSize integer(int32)
USQOS
Name Schema
FilterProfile string
FilterProfileID integer(int32)
QOSGroupType string
ServiceGroup string
ServiceGroupID integer(int32)
ServiceProfile string
ServiceProfileID integer(int32)
USRateShaping
Name Schema
CIR number(double)
Cost number(double)
EnableCIR boolean
EnableEIR boolean
EnableMaxIR boolean
EnableMinIR boolean
MaxIR number(double)
MinIR number(double)
MinMODCOD string
Priority string
RemoteListItem
Name Schema
Active boolean
DID integer(int32)
ID integer(int32)
IsSCPC boolean
ModelType string
Name string
SN string
RemoteListResponse
Name Schema
data < RemoteListItem > array
errors Errors
meta Meta
RemoteMember
Name Schema
RemoteID integer(int32)
RemoteName string
RemoteProfileID integer(int32)
RemoteResponse
Name Schema
data Remote
errors Errors
meta Meta
RemoteServiceGroup
AllocRelToCIR boolean
AllocRelToNominal boolean
AllocRelToOperationa
boolean
l
ConfiguredRates ConfiguredRates
Downstream boolean
EffectiveRates EffectiveRates
EnableEIR boolean
ID Internal ID of the RemoteServiceGroup integer
MinMODCOD string
Name Name of the RemoteServiceGroup string
ParentName string
Priority string
< RemoteMember >
RemoteWithProfiles
array
StickyCIR boolean
ConfiguredRates
Name Schema
Cost number(double)
EnableCIR boolean
EnableMIR boolean
EffectiveRates
Name Schema
CirModcodTable CirModcodTable
Cost number(double)
MirModcodTable MirModcodTable
CirModcodTable
Name Schema
MirModcodTable
Name Schema
RemoteServiceGroupListItem
Name Schema
Downstream boolean
ID integer(int32)
Name string
ParentName string
QOSGroupType string
QOSMode string
RemoteServiceGroupListResponse
Name Schema
data < RemoteServiceGroupListItem > array
errors Errors
meta Meta
RemoteServiceGroupResponse
Name Schema
data RemoteServiceGroup
errors Errors
meta Meta
RoamingInstance
Name Schema
ID integer(int32)
IsSCPC boolean
RoamingRemote
Name Schema
IsSCPC boolean
RouteMaps
Name Schema
RouteMapNumber integer(int32)
Rules < Rule > array
Rule
Name Schema
Continue integer(int32)
IPPrefix IPPrefix
MaAFI string
MaASPath string
MaCommunity string
MaExCommunity string
MaMed integer(int32)
MaSAFI string
ORFAssociation string
Permit boolean
RuleNumber integer(int32)
SNRMetricRouteMapIndex integer(int32)
SeASAction string
SeASTimes integer(int32)
SeCommunity string
SeCommunityAction string
SeExCommunity string
SeExCommunityAction string
SeLocalPref integer(int32)
SeMed integer(int32)
SeNextHopAddress string
SeOrigin string
SeWeight integer(int32)
IPPrefix
Name Schema
AFI string
Address string
GEValue integer(int32)
LEValue integer(int32)
Len integer(int32)
Match string
Permit string
PrefixNumber integer(int32)
SAFI string
SVN
Name Schema
BGPEnabled boolean
Enabled boolean
L3 L3
LocalIdCe integer(int32)
LocalIdSp integer(int32)
SvnID integer(int32)
L3
Name Schema
BGP BGP
ETH0IPAddress string
ETH0SubnetMask string
SAT0IPAddress string
SAT0SubnetMask string
BGP
Name Schema
AS integer(int32)
AggregateAddresses < AggregateAddress > array
ConfigTables < ConfigTables > array
Enabled boolean
ORF ORF
PeerGroups < PeerGroups > array
Peers < Peers > array
RemoteID integer(int32)
RouteMaps < RouteMaps > array
RouteRedistribution RouteRedistribution
ORF
Name Schema
Enabled boolean
SendRecv string
Type string
RouteRedistribution
Name Schema
ConnectedRoutesEnabled boolean
RIPRoutesEnabled boolean
StaticRoutesEnabled boolean
SkewGain
Name Schema
Gain number(double)
Skew integer(int32)
Spacecraft
ID Internal ID of the Spacecraft integer
InclineOrbit number(double)
Longitude number(double)
MaxSkew number(double)
MinimumLookAngle number(double)
Name Name of the Spacecraft string
OperatorID integer(int32)
OperatorRefName string
SkewMargin number(double)
SkewPolarization number(double)
StationBoxAngle number(double)
SpacecraftListItem
Name Schema
ID integer(int32)
Name string
SpacecraftListResponse
Name Schema
data < SpacecraftListItem > array
errors Errors
meta Meta
SpacecraftResponse
Name Schema
data Spacecraft
errors Errors
meta Meta
StaticRoute
Name Schema
Cost integer(int32)
Gateway string
IPAddress string
Interface string
SubnetMask string
Status
Name Schema
HubSideStatus string
RemoteSideStatus string
Status string
StatusResponse
Name Schema
data Status
meta Meta
SwitchPort
Name Schema
AutoNegotiation boolean
FullDuplex boolean
PortNumber integer(int64)
Speed100Mbps boolean
VlanIDs < integer(int32) > array
Teleport
Alt number(double)
BackupNMS boolean
CfgSrvIPAddress string
EvtSrvIPAddress string
ID Internal ID of the Teleport integer
Lat number(double)
Lon number(double)
Name Name of the Teleport string
NrdSrvIPAddress string
Phone string
TeleportListItem
Name Schema
ID integer(int32)
Latitude number(float)
Longitude number(float)
Name string
TeleportListResponse
Name Schema
data < TeleportListItem > array
errors Errors
meta Meta
TeleportResponse
Name Schema
data Teleport
errors Errors
meta Meta
UpConverter
ID Internal ID of the UpConverter integer
ManufacturerID integer(int32)
ManufacturerPN string
Name Name of the UpConverter string
ODUTx10MHz boolean
ODUTxDCPower boolean
iDirectPN string
UpConverterListItem
Name Schema
ID integer(int32)
Name string
UpConverterListResponse
Name Schema
data < UpConverterListItem > array
errors Errors
meta Meta
UpConverterResponse
Name Schema
data UpConverter
errors Errors
meta Meta
User
AccessLevel string
ID Internal ID of the User integer
LoginName string
Name Name of the User string
Password string
Permissions < string > array
UserGroupID integer(int32)
UserListItem
Name Schema
ID integer(int32)
Name string
UserListResponse
Name Schema
data < UserListItem > array
errors Errors
meta Meta
UserResponse
Name Schema
data User
errors Errors
meta Meta
VLanInfo
Name Schema
DHCP DHCP
DNS DNS
ETH0IPAddress string
ETH0RIPv2 boolean
ETH0SubnetMask string
GreTunnels < GreTunnel > array
MulticastGroups < MulticastGroup > array
NAT boolean
PortForwarding < PortForward > array
SAT0IPAddress string
SAT0RIPv2 boolean
SAT0SubnetMask string
StaticRoutes < StaticRoute > array
VLanID integer(int64)
DHCP
Name Schema
DefaultGwAddr string
DhcpMode integer(int32)
LeaseSeconds integer(int64)
PrimaryDnsAddr string
RelayServer string
SecondaryDnsAddr string
DNS
Name Schema
CacheSize integer(int64)
Enabled boolean
FwdQSize integer(int64)
FwdTimeout integer(int64)
PrimaryAddr string
PrimaryName string
SecondaryAddr string
SecondaryName string
Security
basicAuth
The standard HTTP Basic Access Authentication is supported.
This is the preferred mechanism of user authorization and is in keeping with the RESTful
philosophy of a stateless web server. Each individual HTTP request must contain the Authorization
HTTP header and the server does not store any client state.
User credentials are passed with each request using standard Basic Access Authentication; which is
an HTTP header in the following form:
Authorization: Basic <Base64(user:password)>
The user name, a colon, and password are concatenated and then Base64 encoded. The following is
an example of an actual Authorization header:
Authorization: Basic YWRtaW46bXlzZWNyZXRwYXNzd29yZA==
Note that the Base64 encoding is not intended to provide any security, but rather is used to avoid
character encoding issues and escape sequences within the user name or password.
More information about the HTTP Basic Access Authentication can be obtained from:
http://en.wikipedia.org/wiki/Basic_access_authentication
Type : basic
cookieAuth
Type : apiKey
Name : Session
In : HEADER
Examples
iVantage A
16 Technical Note
iDirect
13861 Sunrise Valley Drive, Suite 300
Herndon, VA 20171-6126
+1 703.648.8000
+1 866.345.0983
www.idirect.net
Advancing a Connected World

TN iVantageAPI T0000960 RevC 12 11 18

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

TN iVantageAPI T0000960 RevC 12 11 18

Uploaded by

Copyright:

Available Formats

Technical Note Evolution

iDX Release 4.1

Document Name: TN_iVantageAPI__T0000960_RevC_12_11_18

Revision Date Updates

Technical Note iii

Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii

Convention Description Example

Technical Note vii

Convention Description Example

WARNING: A warning highlights an essential operating or maintenance procedure,

CAUTION: A caution highlights an essential operating or maintenance procedure,

NOTE: A note is a statement or other notification that adds, emphasizes, or

viii Technical Note

• iDirect Government: techpubs@idirectgov.com

Figure 1-1. NMS-Server Architecture

Table 1-1. API Processes

Process Name Description

Configuring the API Services

3. Edit the default.yaml file on the host. For example, /opt/NodeNMS/swagger-

Session Cookie Authentication

HTTP/1.1 302 Found

HTTP/1.1 302 Found

HTTP/1.1 302 Found

HTTP/1.1 302 Found

HTTP/1.1 401 Unauthorized

Session Cookie Use

POST /authorize?logout&success=/logged-out.html HTTP/1.1

HTTP/1.1 302 Found

HTTP/1.1 302 Found

{ "Name" : "Renamed Name" }

List all applicationservicegroups

HTTP Code Description Schema

Type Name Scopes

Returns the applicationservicegroup with ID = applicationservicegroupId

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

Updates the applicationservicegroup and returns the updated applicationservicegroup. Note&#58;

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

List all bucs

HTTP Code Description Schema

Type Name Scopes

Returns the buc with ID = bucId

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

Creates the Carrier

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

List all carriers

HTTP Code Description Schema

Type Name Scopes

Returns the carrier with ID = carrierId

Type Name Description Schema Default

HTTP Code Description Schema

Type Name Scopes

Deletes the carrier with ID = carrierId

Updates the applicationservicegroup and returns the updated applicationservicegroup. Note: