Technical Note

iVantage API

Evolution

iDX 4.3.x

Revision 3

October 31, 2023

© 2023 ST Engineering iDirect, Inc. dba iDirect and/or its affiliates. All rights reserved.

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. While every effort has been made to ensure the accuracy of the statements,
information and recommendations in this document, they are provided 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.

ST Engineering iDirect is a global leader in satellite communications (satcom) providing technology and solutions
that enable its customers to expand their business, differentiate their services and optimize their satcom networks.
Through the merger with Newtec, a recognized industry pioneer, the combined business unites over 35 years of
innovation focused on solving satellite’s most critical economic and technology challenges, and expands a shared
commitment to shaping the future of how the world connects. The product portfolio, branded under the names iDirect
and Newtec, represents the highest standards in performance, efficiency and reliability, making it possible for its
customers to deliver the best satcom connectivity experience anywhere in the world. ST Engineering iDirect is the
world’s largest TDMA enterprise VSAT manufacturer and is the leader in key industries including broadcast, mobility
and military/government.

Company Website: www.idirect.net | Main Phone: 703.648.8000

TAC Contact Information: Phone: 703.648.8151 | Email: [email protected] | Website: www.support.idirect.net

iDirect Government created in 2007, is a wholly owned subsidiary of ST Engineering iDirect and was formed to better
serve the U.S. government and defense communities. In 2019, iDirect Government acquired Glowlink
Communications Technology, Inc.

Company Website: www.idirectgov.com | Main Phone: 703.648.8118

TAC Contact Information: Phone: 703.648.8111 | Email: [email protected] | Website: partnerportal.idirectgov.com

Document Name: TN_iVantageAPI__T0001403_31_Oct_2023 Rev3

Document Part Number: T0001403

ii Technical Note
Evolution | T0001403 | Revision 3
 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 xiii for TAC access information.

Revision Date Updates

1 January 31, 2023 Initial release of the document.
2 March 31, 2023 Updated iVantage API section.
3 October 31, 2023 Updated for iDX 4.3.1.1.

Technical Note iii

Evolution | T0001403 | Revision 3
Revision History

iv Technical Note
Evolution | T0001403 | Revision 3
 Contents

Contents

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

About . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
Getting Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
iDirect Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiii
iDirect Government Contact Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
Document Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

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

Technical Note v
Evolution | T0001403 | Revision 3
Contents

example Call . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
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

iVantage API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Version information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
URI scheme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Consumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Produces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Applicationservicegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
GET /applicationservicegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
GET /applicationservicegroup/{applicationservicegroupId} . . . . . . . . . . . . . . . 20
PATCH /applicationservicegroup/{applicationservicegroupId}. . . . . . . . . . . . . . 21
Authorize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
POST /authorize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Buc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
GET /buc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

vi Technical Note
Evolution | T0001403 | Revision 3
 Contents

GET /buc/{bucId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
POST /carrier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
GET /carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
GET /carrier/{carrierId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
DELETE /carrier/{carrierId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
PATCH /carrier/{carrierId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Downconverter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
POST /downconverter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
GET /downconverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
GET /downconverter/{downconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
DELETE /downconverter/{downconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . 36
PATCH /downconverter/{downconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . 37
Hubrft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
POST /hubrft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
GET /hubrft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
GET /hubrft/{hubrftId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
DELETE /hubrft/{hubrftId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
PATCH /hubrft/{hubrftId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Inroutegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
POST /inroutegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
GET /inroutegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
GET /inroutegroup/{inroutegroupId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
DELETE /inroutegroup/{inroutegroupId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
PATCH /inroutegroup/{inroutegroupId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Linecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
POST /linecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
GET /linecard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
GET /linecard/{linecardId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
DELETE /linecard/{linecardId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
PATCH /linecard/{linecardId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Lnb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Technical Note vii

Evolution | T0001403 | Revision 3
Contents

GET /lnb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
GET /lnb/{lnbId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
POST /network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
GET /network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
GET /network/{networkId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
DELETE /network/{networkId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
PATCH /network/{networkId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Reflector. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
GET /reflector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
GET /reflector/{reflectorId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Remote. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
POST /remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
GET /remote. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
GET /remote/{remoteId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
DELETE /remote/{remoteId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
PATCH /remote/{remoteId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
POST /remote/{remoteId}/add_roaming_instance . . . . . . . . . . . . . . . . . . . . . 77
PATCH /remote/{remoteId}/apply_changes . . . . . . . . . . . . . . . . . . . . . . . . . 78
GET /remote/{remoteId}/raw_optionsfile . . . . . . . . . . . . . . . . . . . . . . . . . . 79
PATCH /remote/{remoteId}/reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
GET /remote/{remoteId}/status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
PATCH /remote/{remoteId}/stop_cw_pn . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
PATCH /remote/{remoteId}/tx_cw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
PATCH /remote/{remoteId}/tx_pn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Remoteservicegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
GET /remoteservicegroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
GET /remoteservicegroup/{remoteservicegroupId}. . . . . . . . . . . . . . . . . . . . . 87
PATCH /remoteservicegroup/{remoteservicegroupId} . . . . . . . . . . . . . . . . . . . 88
Spacecraft. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
POST /spacecraft. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
GET /spacecraft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

viii Technical Note

Evolution | T0001403 | Revision 3
 Contents

GET /spacecraft/{spacecraftId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
DELETE /spacecraft/{spacecraftId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
PATCH /spacecraft/{spacecraftId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Teleport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
POST /teleport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
GET /teleport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
GET /teleport/{teleportId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
DELETE /teleport/{teleportId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
PATCH /teleport/{teleportId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Upconverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
POST /upconverter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
GET /upconverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
GET /upconverter/{upconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
DELETE /upconverter/{upconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
PATCH /upconverter/{upconverterId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
POST /user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
GET /user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
GET /user/{userId}. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
PATCH /user/{userId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Definitions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
AggregateAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
ApplicationMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
ApplicationServiceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
ApplicationServiceGroupListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
ApplicationServiceGroupListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
ApplicationServiceGroupResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ApplyChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ApplyChangesRequest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
ApplyChangesResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
BUC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
BUCListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Technical Note ix
Evolution | T0001403 | Revision 3
Contents

BUCListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
BUCResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
CW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Carrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
CarrierListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
CarrierListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
CarrierResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
ConfigTables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
DhcpClnAddrRange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
DiscretePort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
DownConverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
DownConverterListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
DownConverterListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
DownConverterResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ElevationGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
GreTunnel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
HubRFT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
HubRFTListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
HubRFTListResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
HubRFTResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
InrouteGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
InrouteGroupListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
InrouteGroupListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
InrouteGroupResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
LNB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
LNBListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
LNBListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
LNBResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Linecard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

x Technical Note
Evolution | T0001403 | Revision 3
 Contents

LinecardResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
MCGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Meta . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
MulticastGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
NetworkListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
NetworkListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
NetworkResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
PN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
PeerGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Peers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
PortForward . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
RXCarrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Reflector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
ReflectorListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ReflectorListResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
ReflectorResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
RemoteListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
RemoteListResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
RemoteMember . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
RemoteResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
RemoteServiceGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
RemoteServiceGroupListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
RemoteServiceGroupListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
RemoteServiceGroupResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
RoamingInstance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
RoamingRemote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
RouteMaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
SVN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
SkewGain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Technical Note xi
Evolution | T0001403 | Revision 3
Contents

Spacecraft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
SpacecraftListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
SpacecraftListResponse. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
SpacecraftResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
StaticRoute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
StatusResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
SwitchPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Teleport. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
TeleportListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
TeleportListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
TeleportResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
UpConverter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
UpConverterListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
UpConverterListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
UpConverterResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
UserListItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
UserListResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
UserResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
VLanInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
basicAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
cookieAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Appendix A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
RemoteList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
MultiEdit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
MultiApply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

xii Technical Note

Evolution | T0001403 | Revision 3
 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.
• Appendix A
The appendix provides examples of dynamic APIs.

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.

iDirect Contact Information

• Website: http://support.idirect.net
• Telephone: 703.648.8151
• E-mail: [email protected]

Technical Note xiii

Evolution | T0001403 | Revision 3
About

iDirect Government Contact Information

• Website: partnerportal.idirectgov.com
• Telephone: 703.648.8111
• E-mail: [email protected]
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: [email protected]
• iDirect Government: [email protected]
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: [email protected]

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

xiv Technical Note

Evolution | T0001403 | Revision 3
 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
Evolution | T0001403 | Revision 3
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
Evolution | T0001403 | Revision 3
 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
Evolution | T0001403 | Revision 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
Evolution | T0001403 | Revision 3
 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
Evolution | T0001403 | Revision 3
Examples

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

Cookie: session=8df914a9b578973208b1283087561e0d

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
Cookie: session=8df914a9b578973208b1283087561e0d

HTTP/1.1 302 Found

Set-Cookie: session=; Max-Age=0
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
Cookie: session=8df914a9b578973208b1283087561e0d

HTTP/1.1 200 OK
Set-Cookie: session=; Max-Age=0
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
Evolution | T0001403 | Revision 3
 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
curl -s -k -u admin:admin -iX GET
https://127.0.0.1:443/api/v1/evo/config/obj/remote/8

example response 2
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Sun, 012 Sep 2015 13:09:59 GMT
Connection: keep-alive
Transfer-Encoding: chunked
{
"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
Evolution | T0001403 | Revision 3
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
Content-Type: application/json; charset=utf-8
Date: Mon, 10 Aug 2015 00:13:46 GMT

8 Technical Note
Evolution | T0001403 | Revision 3
 Examples

Connection: keep-alive
Transfer-Encoding: chunked
[
{
"Name": "Remote #8",
"ID": "8",
"DID": "234987906",
"NetworkID": "2",
"InrouteGroupID": "6",
"LinecardID": "0"
},
{
"Name": "Remote #10",
"ID": "10",
"DID": "234987911",
"NetworkID": "2",
"InrouteGroupID": "6",
"LinecardID": "0"
},
{
"Name": "Remote #908",
"ID": "908",
"DID": "235021302",
"NetworkID": "2",
"InrouteGroupID": "3",
"LinecardID": "0"
},
{
"Name": "Remote #909",
"ID": "909",
"DID": "235004748",
"NetworkID": "2",
"InrouteGroupID": "3",
"LinecardID": "0"
}
]

Technical Note 9
Evolution | T0001403 | Revision 3
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",
"InrouteGroupID": "1",
"NetworkID": "1",
"Active": "1",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"IsMobile": "0",
"TXPower": "-15",
"Lat": "-26.24828",
"Lon": "28.18183",
"SymbolRate": "459",
"MODCOD": "QPSK3/4",
"InitialPower": "-15",
"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
Evolution | T0001403 | Revision 3
 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
Content-Type: application/json; charset=utf-8
Date: Sat, 12 Sep 2015 14:31:26 GMT
Connection: keep-alive
Transfer-Encoding: chunked
{
"ID": "80",
"Name": "New VSat Terminal",
"SN": "106887",
"DID": "234987912",
"ModelType": "X1",
"InrouteGroupID": "1",
"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",
"TCPCompression": "0",

Technical Note 11
Evolution | T0001403 | Revision 3
Examples

"UDPHdrCompression": "0",
"UDPCompression": "0",
"LinkEncryption": "0",
"CRTP": "0",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"AntennaID": "0",
"AntennaTxHandshake": "0",
"IsMobile": "0",
"IsSCPC": "0",
"SCPCPeerID": "0",
"IsRoaming": "0",
"SymbolRate": "459",
"MODCOD": "QPSK3/4",
"InitialPower": "-15",
"MaxPower": "-5",
"SpreadingFactor": "0",
"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
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: Sat, 12 Sep 2015 16:45:55 GMT
Connection: keep-alive
Transfer-Encoding: chunked

12 Technical Note
Evolution | T0001403 | Revision 3
 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
Content-Type: application/json; charset=utf-8
Date: Sun, 13 Sep 2015 00:40:47 GMT
Connection: keep-alive
Transfer-Encoding: chunked
{
"ID": "8",
"Name": "Vsat Name",
"Status": "",
"SN": "126343",
"DID": "235007367",
"ModelType": "X1",
"InrouteGroupID": "3",
"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",
"TCPCompression": "0",
"UDPHdrCompression": "0",
"UDPCompression": "0",

Technical Note 13
Evolution | T0001403 | Revision 3
Examples

"LinkEncryption": "0",
"CRTP": "0",
"UpCIR": "256",
"UpMIR": "2048",
"UpMIN": "2",
"DownCIR": "512",
"DownMIR": "4096",
"AntennaID": "1316",
"AntennaTxHandshake": "0",
"IsMobile": "0",
"IsSCPC": "0",
"SCPCPeerID": "0",
"IsRoaming": "0",
"SymbolRate": "918",
"MODCOD": "QPSK3/4",
"InitialPower": "14",
"MaxPower": "5",
"SpreadingFactor": "0",
"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
https://127.0.0.1:443/api/v1/evo/config/obj/remote/1446

example response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Fri, 21 Aug 2015 23:07:47 GMT
Connection: keep-alive
Transfer-Encoding: chunked
.

14 Technical Note
Evolution | T0001403 | Revision 3
 iVantage API

Technical Note 15
Evolution | T0001403 | Revision 3
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

Tags
• Applicationservicegroup : Refers to a group or collection of application services.

• Authorize : Relates to the process of granting or denying access to certain resources or functionalities
based on user permissions or roles.

• Buc : BUC stands for Block Upconverter.

• Carrier : A carrier refers to a signal that carries information.

• Downconverter : Device used to convert the frequency of an incoming signal from a higher frequency
(Ku-band or C-band) to a lower frequency (L-band) for further processing or demodulation.

• Hubrft : Hub or central point in a radio frequency transmission system.

• Inroutegroup : Collection of in-route elements or components within a network or communication

system.

• Linecard : A line card hardware component.

• Lnb : LNB stands for Low-Noise Block Downconverter.

• Network : A collection of interconnected devices or systems that can communicate and share
resources.

• Reflector : Reflector refers to a large dish-shaped antenna that reflects or focuses incoming or
outgoing signals.

• Remote : A remote refers to remote hardware device.

• Remoteservicegroup : A collection of remote services.

• Spacecraft : Communication sattelite.

• Teleport : Hub location.

• Upconverter : Device used to convert the frequency of an incoming signal from a lower frequency (L-
band) to a higher frequency (Ku-band or C-band) for further processing or demodulation.

16
 • User : A user account.

Consumes
• application/json
• text/xml

Produces
• application/json
• text/html

17
Resources

Applicationservicegroup
Refers to a group or collection of application services.

18
GET /applicationservicegroup

Description

List all applicationservicegroups

Responses

HTTP Code Description Schema

ApplicationService
200 List all applicationservicegroups
GroupListResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

19
GET /applicationservicegroup/{applicationservicegroupId}

Description

Returns the applicationservicegroup with ID = applicationservicegroupId

Parameters

Type Name Description Schema

applicationser
Path vicegroupId ID of the applicationservicegroup integer
required

Responses

HTTP Code Description Schema

ApplicationService
200 Returns the applicationservicegroup with ID = applicationservicegroupId
GroupResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

20
PATCH /applicationservicegroup/{applicationservicegroupId}

Description

Updates the applicationservicegroup and returns the updated applicationservicegroup.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

applicationser
Path vicegroupId ID of the applicationservicegroup integer
required

ApplicationSer
The applicationservicegroup JSON you want to ApplicationServiceGr
Body viceGroup
update the applicationservicegroup with oup
required

Responses

HTTP Code Description Schema

ApplicationService
200 Returns the updated applicationservicegroup
GroupResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

21
Authorize
Relates to the process of granting or denying access to certain resources or functionalities based on user
permissions or roles.

POST /authorize

Description

Login user and receive a session token in the header, or Logout existing session token.

Parameters

Type Name Description Schema

Query fail Location to redirect to upon failed login or logout string

Query logout If included will logout and delete session string

password
Query The password of the user string
required

Location to redirect to upon successful login or

Query success string
logout

user
Query The username of the user string
required

Responses

HTTP Code Description Schema

200 Success string

302 Redirect to success parameter on success or fail parameter on fail No Content

Security

Type Name

basic basicAuth

apiKey cookieAuth

22
Buc
BUC stands for Block Upconverter.

GET /buc

Description

List all bucs

Responses

HTTP Code Description Schema

200 List all bucs BUCListResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

23
GET /buc/{bucId}

Description

Returns the buc with ID = bucId

Parameters

Type Name Description Schema

bucId
Path ID of the buc integer
required

Responses

HTTP Code Description Schema

200 Returns the buc with ID = bucId BUCResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

24
Carrier
A carrier refers to a signal that carries information.

25
POST /carrier

Description

Creates the Carrier

Parameters

Type Name Description Schema

Carrier
Body The carrier JSON you want to post Carrier
required

Responses

HTTP Code Description Schema

201 Creates the Carrier and returns it CarrierResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

26
 {
"ID": null,
"Name": "carrierName",
"SpacecraftID": "spacecraftID",
"TransponderID": "transponderID",
"BandwidthID": "bandwidthID",
"Type": "carrierType",
"InboundMode": "carrierInboundMode",
"UplinkFreq": "carrierUplinkFreq",
"DownlinkFreq": "carrierDownlinkFreq",
"Power": -25,
"SpreadingFactor": "carrierSpreadingFactor",
"SymbolRate": "carrierSymbolRate",
"FecRate": "carrierFecRate",
"ModulationType": "carrierModulationType",
"MinModcod": "N/A",
"MaxModcod": "N/A",
"CarrierSpacing": 1.2,
"Superburst": true,
"SpreadAcqEnabled": false
}

27
GET /carrier

Description

List all carriers

Responses

HTTP Code Description Schema

CarrierListRespons
200 List all carriers
e

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

28
GET /carrier/{carrierId}

Description

Returns the carrier with ID = carrierId

Parameters

Type Name Description Schema

carrierId
Path ID of the carrier integer
required

Responses

HTTP Code Description Schema

200 Returns the carrier with ID = carrierId CarrierResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

29
DELETE /carrier/{carrierId}

Description

Deletes the carrier with ID = carrierId

Parameters

Type Name Description Schema

carrierId
Path ID of the carrier integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

30
PATCH /carrier/{carrierId}

Description

Updates the carrier and returns the updated carrier.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

carrierId
Path ID of the carrier integer
required

Carrier The carrier JSON you want to update the carrier

Body Carrier
required with

Responses

HTTP Code Description Schema

200 Returns the updated carrier CarrierResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

31
Downconverter
Device used to convert the frequency of an incoming signal from a higher frequency (Ku-band or C-band)
to a lower frequency (L-band) for further processing or demodulation.

POST /downconverter

Description

Creates the DownConverter

Parameters

Type Name Description Schema

DownConverte
Body r The downconverter JSON you want to post DownConverter
required

Responses

HTTP Code Description Schema

DownConverterRes
201 Creates the DownConverter and returns it
ponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

32
 {
"ID": 1,
"Name": "DownConverter_Test",
"ManufacturerID": "manufacturerID",
"ManufacturerPN": "DownConverter_Test",
"iDirectPN": "",
"TranslationFreq": 0,
"ODURxDCPower": false,
"ODURx10MHz": false,
"SpectralInversion": "Normal",
"Stability": 0.01
}

33
GET /downconverter

Description

List all downconverters

Responses

HTTP Code Description Schema

DownConverterList
200 List all downconverters
Response

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

34
GET /downconverter/{downconverterId}

Description

Returns the downconverter with ID = downconverterId

Parameters

Type Name Description Schema

downconverter
Path Id ID of the downconverter integer
required

Responses

HTTP Code Description Schema

DownConverterRes
200 Returns the downconverter with ID = downconverterId
ponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

35
DELETE /downconverter/{downconverterId}

Description

Deletes the downconverter with ID = downconverterId

Parameters

Type Name Description Schema

downconverter
Path Id ID of the downconverter integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

36
PATCH /downconverter/{downconverterId}

Description

Updates the downconverter and returns the updated downconverter.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

downconverter
Path Id ID of the downconverter integer
required

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

Responses

HTTP Code Description Schema

DownConverterRes
200 Returns the updated downconverter
ponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

37
Hubrft
Hub or central point in a radio frequency transmission system.

POST /hubrft

Description

Creates the HubRFT

Parameters

Type Name Description Schema

HubRFT
Body The hubrft JSON you want to post HubRFT
required

Responses

HTTP Code Description Schema

201 Creates the HubRFT and returns it HubRFTResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

38
 {
"ID": null,
"Name": "Test HubRFT",
"Status": "",
"TeleportID": "teleportID",
"AntennaID": 0,
"UpConverterID": "upConverterID",
"DownConverterID": "downConverterID",
"HPAID": 0,
"SpacecraftID": "spacecraftID"
}

39
GET /hubrft

Description

List all hubrfts

Responses

HTTP Code Description Schema

HubRFTListRespons
200 List all hubrfts
e

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

40
GET /hubrft/{hubrftId}

Description

Returns the hubrft with ID = hubrftId

Parameters

Type Name Description Schema

hubrftId
Path ID of the hubrft integer
required

Responses

HTTP Code Description Schema

200 Returns the hubrft with ID = hubrftId HubRFTResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

41
DELETE /hubrft/{hubrftId}

Description

Deletes the hubrft with ID = hubrftId

Parameters

Type Name Description Schema

hubrftId
Path ID of the hubrft integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

42
PATCH /hubrft/{hubrftId}

Description

Updates the hubrft and returns the updated hubrft.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

hubrftId
Path ID of the hubrft integer
required

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

Responses

HTTP Code Description Schema

200 Returns the updated hubrft HubRFTResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

43
Inroutegroup
Collection of in-route elements or components within a network or communication system.

POST /inroutegroup

Description

Creates the InrouteGroup

Parameters

Type Name Description Schema

InrouteGroup
Body The inroutegroup JSON you want to post InrouteGroup
required

Responses

HTTP Code Description Schema

InrouteGroupRespo
201 Creates the InrouteGroup and returns it
nse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

44
 {
"ID" : null,
"Name" : "IGName",
"Status" : "",
"NetworkID" : "validNW",
"QosMode" : "IGQosMode",
"BandwidthGroupIDs" : [
"bandwidthID1",
"bandwidthID2"
],
"MaxCotmSpeed" : 0,
"Timeplan" : {
"AcqAperture" : 1714.37,
"GuardInterval" : 252
},
"Adaptive" : {
"AllowedDropoutFraction" : 0,
"DefaultIgcID" : 0,
"UpdateInterval" : 60,
"FixedIgcID" : 1
},
"CarrierIDs" : [
"validCarrierID1",
"validCarrierID2"
],
"Compositions" : [
{
"ID" : "IGCID",
"Name" : "IGCName",
"ModcodForEachCarrier" : [
"BPSK1/2",
"BPSK1/2"
]
}
]
}

45
GET /inroutegroup

Description

List all inroutegroups

Responses

HTTP Code Description Schema

InrouteGroupListRe
200 List all inroutegroups
sponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

46
GET /inroutegroup/{inroutegroupId}

Description

Returns the inroutegroup with ID = inroutegroupId

Parameters

Type Name Description Schema

inroutegroupId
Path ID of the inroutegroup integer
required

Responses

HTTP Code Description Schema

InrouteGroupRespo
200 Returns the inroutegroup with ID = inroutegroupId
nse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

47
DELETE /inroutegroup/{inroutegroupId}

Description

Deletes the inroutegroup with ID = inroutegroupId

Parameters

Type Name Description Schema

inroutegroupId
Path ID of the inroutegroup integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

48
PATCH /inroutegroup/{inroutegroupId}

Description

Updates the inroutegroup and returns the updated inroutegroup.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

inroutegroupId
Path ID of the inroutegroup integer
required

InrouteGroup The inroutegroup JSON you want to update the

Body InrouteGroup
required inroutegroup with

Responses

HTTP Code Description Schema

InrouteGroupRespo
200 Returns the updated inroutegroup
nse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

49
Linecard
A line card hardware component.

POST /linecard

Description

Creates the Linecard

Parameters

Type Name Description Schema

Linecard
Body The linecard JSON you want to post Linecard
required

Responses

HTTP Code Description Schema

201 Creates the Linecard and returns it LinecardResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

50
 {
"ID": null,
"Name": "validLCName",
"NetworkID": "validNetworkId",
"HubRFTID": "hubRFTID",
"ChassisID": "chasisID",
"SN": "validLCSN",
"DID": null,
"ModelType": "validLCModelType",
"Active": true,
"LinecardType": "validLCType",
"UserPassword": "iDirect",
"AdminPassword": "iDirect",
"ReceiveMode": "validLCRMode",
"MgmtIPAddress": "mgmtLCIPAddress",
"MgmtSubnetMask": "MgmtLCSubnetMask",
"MgmtGateway": "mgmtLCGateway",
"GIG0IPAddress": "GIGOLCIPAddress",
"GIG0SubnetMask": "GIGOLCSubnetMask",
"GIG0Gateway": "GIGOLCGateway",
"GIG0Speed": "GIG0LCSpeed",
"TxCarrierID": "validTXCarrierId",
"AltTxCarrierID": "validTXCarrierId",
"RxCenterFreq": "rxCenterFreq",
"RXCarrierIds": [
{
"Name": "validRXCarrierName",
"ID": "validRXCarrierId"
}
]
}

51
GET /linecard

Description

List all linecards

Responses

HTTP Code Description Schema

200 List all linecards LinecardResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

52
GET /linecard/{linecardId}

Description

Returns the linecard with ID = linecardId

Parameters

Type Name Description Schema

linecardId
Path ID of the linecard integer
required

Responses

HTTP Code Description Schema

200 Returns the linecard with ID = linecardId LinecardResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

53
DELETE /linecard/{linecardId}

Description

Deletes the linecard with ID = linecardId

Parameters

Type Name Description Schema

linecardId
Path ID of the linecard integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

54
PATCH /linecard/{linecardId}

Description

Updates the linecard and returns the updated linecard.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

linecardId
Path ID of the linecard integer
required

Linecard The linecard JSON you want to update the linecard

Body Linecard
required with

Responses

HTTP Code Description Schema

200 Returns the updated linecard LinecardResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

55
Lnb
LNB stands for Low-Noise Block Downconverter.

GET /lnb

Description

List all lnbs

Responses

HTTP Code Description Schema

200 List all lnbs LNBListResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

56
GET /lnb/{lnbId}

Description

Returns the lnb with ID = lnbId

Parameters

Type Name Description Schema

lnbId
Path ID of the lnb integer
required

Responses

HTTP Code Description Schema

200 Returns the lnb with ID = lnbId LNBResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

57
Network
A collection of interconnected devices or systems that can communicate and share resources.

58
POST /network

Description

Creates the Network

Parameters

Type Name Description Schema

Network
Body The network JSON you want to post Network
required

Responses

HTTP Code Description Schema

201 Creates the Network and returns it NetworkResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

59
GET /network

Description

List all networks

Responses

HTTP Code Description Schema

NetworkListRespon
200 List all networks
se

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

60
GET /network/{networkId}

Description

Returns the network with ID = networkId

Parameters

Type Name Description Schema

networkId
Path ID of the network integer
required

Responses

HTTP Code Description Schema

200 Returns the network with ID = networkId NetworkResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

61
DELETE /network/{networkId}

Description

Deletes the network with ID = networkId

Parameters

Type Name Description Schema

networkId
Path ID of the network integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

62
PATCH /network/{networkId}

Description

Updates the network and returns the updated network.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

networkId
Path ID of the network integer
required

Network The network JSON you want to update the network

Body Network
required with

Responses

HTTP Code Description Schema

200 Returns the updated network NetworkResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

63
Reflector
Reflector refers to a large dish-shaped antenna that reflects or focuses incoming or outgoing signals.

GET /reflector

Description

List all reflectors

Responses

HTTP Code Description Schema

ReflectorListRespon
200 List all reflectors
se

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

64
GET /reflector/{reflectorId}

Description

Returns the reflector with ID = reflectorId

Parameters

Type Name Description Schema

reflectorId
Path ID of the reflector integer
required

Responses

HTTP Code Description Schema

200 Returns the reflector with ID = reflectorId ReflectorResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

65
Remote
A remote refers to remote hardware device.

66
POST /remote

Description

Creates the Remote

Parameters

Type Name Description Schema

Remote
Body The remote JSON you want to post Remote
required

Responses

HTTP Code Description Schema

201 Creates the Remote and returns it RemoteResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

{
"ID": null,
"Name": "validRmtName",
"Status": "",
"SN": "fakeSN",
"DID": null,
"ModelType": "X5",
"InrouteGroupID": "validIG",
"NetworkID": "validNW",
"Active": true,
"MgmtIPAddress": "mgmtIPAddress",
"MgmtSubnetMask": "MgmtSubnetMask",
"MgmtGateway": "mgmtGateway",
"LanIPAddress": "lanIPAddress",
"LanSubnetMask": "lanSubnetMask",
"LanGateway": "lanGateway",
"RXCarrierID": -1,

67
"TXCarrierID": -1,
"TXPower": -25,
"Lat": 0,
"Lon": 0,
"TCPCompression": false,
"UDPHdrCompression": false,
"UDPCompression": false,
"LinkEncryption": false,
"CRTP": false,
"UpCIR": -0.001,
"UpMIR": -0.001,
"UpMIN": 0,
"DownCIR": 0,
"DownMIR": -0.001,
"DownMIN": 0.001,
"AntennaID": 278,
"AntennaTxHandshake": false,
"IsMobile": false,
"IsSCPC": false,
"SCPCPeerID": 0,
"IsRoaming": false,
"SymbolRate": 1000,
"MODCOD": "BPSK1/2",
"InitialPower": -25,
"MaxPower": 0,
"SpreadingFactor": 0,
"PayloadSize": 170,
"1DB": 0,
"RxOnly": false,
"RxOnlyMulticast": false,
"RxOnlyMCTimeout": 60,
"Mobile": {
"Security": false,
"Handshake": false,
"GPSInput": "Manual",
"GPSRefreshRate": 120,
"SerialDevice": "ttyS0",
"SerialSettings": "4800, 8N1",
"COTMType": "Maritime",
"MinLookAngle": -1,
"MaxSkew": 90,
"SkewMargin": 90
},
"L2oS": {
"SDT": 0,
"Ethertype1": "",
"Ethertype2": "",
"BFD": false,
"Compression": 0,
"MTU": 0
},
"Customer": {
"Name": "test",
"Phone": "111-222-3333",
"CommissionDate": "( date )",
"ContractNumber": "12345",
"SiteNotes": "Testing Remote Instance"
},
"VLans": [
{
"VLanID": 1,
"ETH0IPAddress": "vlan1ETH0IPAddress",

68
 "ETH0SubnetMask": "vlan1ETH0SubnetMask",
"SAT0IPAddress": "vlan1SAT0IPAddress",
"SAT0SubnetMask": "vlan1SAT0SubnetMask",
"ETH0RIPv2": false,
"SAT0RIPv2": false,
"NAT": false,
"DNS": {
"Enabled": true,
"PrimaryName": "ns1",
"PrimaryAddr": "dnsPrimaryAddr",
"SecondaryName": "ns2",
"SecondaryAddr": "dnsSecondaryDnsAddr",
"CacheSize": 100,
"FwdQSize": 1000,
"FwdTimeout": 2000
},
"DHCP": {
"DhcpMode": 1,
"LeaseSeconds": 43200,
"PrimaryDnsAddr": "dhcp1PrimaryAddr",
"SecondaryDnsAddr": "dhcp1SecondaryDnsAddr",
"DefaultGwAddr": "dhcp1GatewayAddr",
"RelayServer": "dhcp1RelayServer",
"ClientAddrRanges": [
{
"StartAddr": "dhcp1StartAddr",
"EndAddr": "dhcp1EndAddr"
}
]
},
"StaticRoutes" : [ {
"IPAddress" : "staticRoute1IP",
"SubnetMask" : "staticRoute1Subnet",
"Gateway" : "staticRoute1Gateway",
"Interface" : "sat0",
"Cost" : 1
},
{
"IPAddress" : "staticRoute2IP",
"SubnetMask" : "staticRoute2Subnet",
"Gateway" : "staticRoute2Gateway",
"Interface" : "sat0",
"Cost" : 1
}
]
}
],
"AntennaComponents": {
"BUCID": "validBUCId",
"LNBIDs": [
"validLNBId"
],
"ReflectorID": "reflectorID",
"BoostLnbVoltage": false,
"ApproxCableLength": 0
},
"RemoteQOS": {
"DSQOS": {
"QOSGroupType": "validDSQOSType",
"FilterProfile": "validDSFilterProfile",
"FilterProfileID": "validDSFilterProfileId",
"ServiceGroup": "validDSServiceGroup",

69
 "ServiceGroupID": "validDSServiceGroupId",
"ServiceProfile": "validDSServiceProfile",
"ServiceProfileID": "validDSServiceProfileId",
"MCServiceProfile": "",
"MCServiceProfileID": 0
},
"DSRateShaping": {
"EnableMaxIR": false,
"MaxIR": 0,
"EnableCIR": false,
"CIR": 0,
"Priority": "Cost Based",
"Cost": 1,
"EnableMinIR": false,
"MinIR": 0,
"EnableEIR": false,
"MinMODCOD": "16APSK-8/9"
},
"DSDistributor": {
"Enabled": true,
"SegmentSize": 70
},
"DSAllocRelToCIR": false,
"NominalMODCOD": "16APSK-8/9",
"MaxMODCOD": "16APSK-8/9",
"USQOS": {
"QOSGroupType": "validUSQOSType",
"FilterProfile": "validUSFilterProfile",
"FilterProfileID": "validUSFilterProfileId",
"ServiceGroup": "validUSServiceGroup",
"ServiceGroupID": "validUSServiceGroupId",
"ServiceProfile": "validUSServiceProfile",
"ServiceProfileID": "validUSServiceProfileId"
},
"USRateShaping": {
"EnableMaxIR": false,
"MaxIR": 0,
"EnableCIR": false,
"CIR": 0,
"Priority": "Cost Based",
"Cost": 1,
"EnableMinIR": false,
"MinIR": 0,
"EnableEIR": false,
"MinMODCOD": "N/A"
},
"USDistributor": {
"Enabled": true,
"SegmentSize": 70
},
"USAdaptive": {
"EnableMaxImpairment": false,
"MaxImpairment": -1,
"MinSymrate": 0,
"MaxCN": 25
},
"IdleDormant": {
"Enabled": false,
"IdleSlotsEvery": 8,
"DormantSlotsEvery": 32,
"IdleSTimeout": 120,
"DormantTimeout": 180

70
 },
"USAllocRelToCIR": false
},
"AdminPassword": "P@55w0rd!",
"UserPassword": "iDirect",
"CustomKeys": {
"RemoteSide": "",
"HubSide": ""
}
}

71
GET /remote

Description

List all remotes

Parameters

Type Name Description Schema

A boolean flag indicating whether to retrieve

Query Active boolean
remotes that are active or inactive

The InrouteGroupID of the remotes you would like

Query DID integer
to match

Query ID The ID of the remote you would like to match integer

InrouteGroupI The InrouteGroupID of the remotes you would like

Query integer
D to match

A boolean flag indicating whether to retrieve

Query IsSCPC boolean
remotes using SCPC return

The model type of the remotes you would like to

Query ModelType string
match

The name or partial name of the remotes you would

Query Name string
like to match

The NetworkID of the remotes you would like to

Query NetworkID integer
match

The ParentID of the remotes you would like to

Query ParentID integer
match

The InrouteGroupID of the remotes you would like

Query SCPCPeerID integer
to match

The serial number of the remote you would like to

Query SN string
match

72
Responses

HTTP Code Description Schema

RemoteListRespons
200 List all remotes
e

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

73
GET /remote/{remoteId}

Description

Returns the remote with ID = remoteId

Parameters

Type Name Description Schema

remoteId
Path ID of the remote integer
required

Responses

HTTP Code Description Schema

200 Returns the remote with ID = remoteId RemoteResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

74
DELETE /remote/{remoteId}

Description

Deletes the remote with ID = remoteId

Parameters

Type Name Description Schema

remoteId
Path ID of the remote integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

75
PATCH /remote/{remoteId}

Description

Updates the remote and returns the updated remote.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

remoteId
Path ID of the remote integer
required

Remote The remote JSON you want to update the remote

Body Remote
required with

Responses

HTTP Code Description Schema

200 Returns the updated remote RemoteResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

76
POST /remote/{remoteId}/add_roaming_instance

Description

Create a Roaming Instance of a Remote

Parameters

Type Name Description Schema

remoteId
Path The id of the remote to send the probe command to. integer
required

Remote
Body The roaming remote JSON you want to post RoamingRemote
required

Responses

HTTP Code Description Schema

201 Created RemoteResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

77
PATCH /remote/{remoteId}/apply_changes

Description

Apply Configuration Changes

Parameters

Type Name Description Schema

remoteId
Path The id of the remote to apply changes to. integer
required

parameters The settings JSON you want to use. Transport can be

Body ApplyChangesRequest
required udp or tcp.

Responses

HTTP Code Description Schema

ApplyChangesResp
202 Accepted
onse

405 Method Not Allowed string

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

78
GET /remote/{remoteId}/raw_optionsfile

Description

Retrieve Options Files for the remote

Parameters

Type Name Description Schema

remoteId
Path The id of the remote to retrieve the options file for. integer
required

Query type The type of options file, HubSide or RmtSide. string

Query version The version of options file, Active or Saved. string

Responses

HTTP Code Description Schema

200 Success string

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

79
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

Type Name Description Schema

remoteId
Path The id of the remote to send the stop command to. integer
required

Responses

HTTP Code Description Schema

202 Accepted No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

80
GET /remote/{remoteId}/status

Description

Query Configuration State

Parameters

Type Name Description Schema

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

Responses

HTTP Code Description Schema

200 Success StatusResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

81
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

Type Name Description Schema

remoteId
Path The id of the remote to send the stop command to. integer
required

Responses

HTTP Code Description Schema

202 Accepted No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

82
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

Type Name Description Schema

remoteId
Path The id of the remote to send the probe command to. integer
required

cw The CW settings JSON you want to use for the

Body CW
required command.

Responses

HTTP Code Description Schema

202 Accepted No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

83
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

Type Name Description Schema

remoteId
Path The id of the remote to send the probe command to. integer
required

The PN settings JSON you want to use for the

pn
Body command. Type Modulation values can be 8PSK, PN
required
QPSK or BPSK.

Responses

HTTP Code Description Schema

202 Accepted No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

84
Remoteservicegroup
A collection of remote services.

85
GET /remoteservicegroup

Description

List all remoteservicegroups

Responses

HTTP Code Description Schema

RemoteServiceGrou
200 List all remoteservicegroups
pListResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

86
GET /remoteservicegroup/{remoteservicegroupId}

Description

Returns the remoteservicegroup with ID = remoteservicegroupId

Parameters

Type Name Description Schema

remoteserviceg
Path roupId ID of the remoteservicegroup integer
required

Responses

HTTP Code Description Schema

RemoteServiceGrou
200 Returns the remoteservicegroup with ID = remoteservicegroupId
pResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

87
PATCH /remoteservicegroup/{remoteservicegroupId}

Description

Updates the remoteservicegroup and returns the updated remoteservicegroup.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

remoteserviceg
Path roupId ID of the remoteservicegroup integer
required

RemoteService
The remoteservicegroup JSON you want to update
Body Group RemoteServiceGroup
the remoteservicegroup with
required

Responses

HTTP Code Description Schema

RemoteServiceGrou
200 Returns the updated remoteservicegroup
pResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

88
Spacecraft
Communication sattelite.

POST /spacecraft

Description

Creates the Spacecraft

Parameters

Type Name Description Schema

Spacecraft
Body The spacecraft JSON you want to post Spacecraft
required

Responses

HTTP Code Description Schema

201 Creates the Spacecraft and returns it SpacecraftResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

89
{
"ID": null,
"Name": "Test Spacecraft",
"OperatorID": 0,
"OperatorRefName": "",
"Longitude": 0,
"InclineOrbit": 0,
"MinimumLookAngle": 0,
"MaxSkew": 90,
"SkewPolarization": 0,
"SkewMargin": 90,
"StationBoxAngle": 0.1
}

90
GET /spacecraft

Description

List all spacecrafts

Responses

HTTP Code Description Schema

SpacecraftListRespo
200 List all spacecrafts
nse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

91
GET /spacecraft/{spacecraftId}

Description

Returns the spacecraft with ID = spacecraftId

Parameters

Type Name Description Schema

spacecraftId
Path ID of the spacecraft integer
required

Responses

HTTP Code Description Schema

200 Returns the spacecraft with ID = spacecraftId SpacecraftResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

92
DELETE /spacecraft/{spacecraftId}

Description

Deletes the spacecraft with ID = spacecraftId

Parameters

Type Name Description Schema

spacecraftId
Path ID of the spacecraft integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

93
PATCH /spacecraft/{spacecraftId}

Description

Updates the spacecraft and returns the updated spacecraft.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

spacecraftId
Path ID of the spacecraft integer
required

Spacecraft The spacecraft JSON you want to update the

Body Spacecraft
required spacecraft with

Responses

HTTP Code Description Schema

200 Returns the updated spacecraft SpacecraftResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

94
Teleport
Hub location.

POST /teleport

Description

Creates the Teleport

Parameters

Type Name Description Schema

Teleport
Body The teleport JSON you want to post Teleport
required

Responses

HTTP Code Description Schema

201 Creates the Teleport and returns it TeleportResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

95
{
"ID": null,
"Name": "Test_Teleport",
"Status": "",
"BackupNMS": false,
"Lat": 0,
"Lon": 0,
"Alt": 0,
"Phone": "123-456-7890",
"CfgSrvIPAddress": "TelCfgSrvIPAddress",
"NrdSrvIPAddress": "TelNrdSrvIPAddress",
"EvtSrvIPAddress": "TelEvtSrvIPAddress"
}

96
GET /teleport

Description

List all teleports

Responses

HTTP Code Description Schema

TeleportListRespon
200 List all teleports
se

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

97
GET /teleport/{teleportId}

Description

Returns the teleport with ID = teleportId

Parameters

Type Name Description Schema

teleportId
Path ID of the teleport integer
required

Responses

HTTP Code Description Schema

200 Returns the teleport with ID = teleportId TeleportResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

98
DELETE /teleport/{teleportId}

Description

Deletes the teleport with ID = teleportId

Parameters

Type Name Description Schema

teleportId
Path ID of the teleport integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

99
PATCH /teleport/{teleportId}

Description

Updates the teleport and returns the updated teleport.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

teleportId
Path ID of the teleport integer
required

Teleport The teleport JSON you want to update the teleport

Body Teleport
required with

Responses

HTTP Code Description Schema

200 Returns the updated teleport TeleportResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

100
Upconverter
Device used to convert the frequency of an incoming signal from a lower frequency (L-band) to a higher
frequency (Ku-band or C-band) for further processing or demodulation.

POST /upconverter

Description

Creates the UpConverter

Parameters

Type Name Description Schema

UpConverter
Body The upconverter JSON you want to post UpConverter
required

Responses

HTTP Code Description Schema

UpConverterRespon
201 Creates the UpConverter and returns it
se

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

101
{
"ID": null,
"Name": "UpConverter_Test",
"Status": "",
"ParentID": 0,
"ManufacturerID": "manufacturerID",
"ManufacturerPN": "UpConverter_Test",
"iDirectPN": "345",
"TranslationFreq": 0,
"ODUTxDCPower": false,
"ODUTx10MHz": false,
"SpectralInversion": "Normal"
}

102
GET /upconverter

Description

List all upconverters

Responses

HTTP Code Description Schema

UpConverterListRes
200 List all upconverters
ponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

103
GET /upconverter/{upconverterId}

Description

Returns the upconverter with ID = upconverterId

Parameters

Type Name Description Schema

upconverterId
Path ID of the upconverter integer
required

Responses

HTTP Code Description Schema

UpConverterRespon
200 Returns the upconverter with ID = upconverterId
se

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

104
DELETE /upconverter/{upconverterId}

Description

Deletes the upconverter with ID = upconverterId

Parameters

Type Name Description Schema

upconverterId
Path ID of the upconverter integer
required

Responses

HTTP Code Description Schema

204 No content No Content

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

105
PATCH /upconverter/{upconverterId}

Description

Updates the upconverter and returns the updated upconverter.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

upconverterId
Path ID of the upconverter integer
required

UpConverter The upconverter JSON you want to update the

Body UpConverter
required upconverter with

Responses

HTTP Code Description Schema

UpConverterRespon
200 Returns the updated upconverter
se

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

106
User
A user account.

POST /user

Description

Creates the User

Parameters

Type Name Description Schema

User
Body The user JSON you want to post User
required

Responses

HTTP Code Description Schema

201 Creates the User and returns it UserResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

Example HTTP request

Request body

{
"UserGroupID" : "validUserGroupId",
"LoginName" : "username1",
"Password" : "password1",
"AccessLevel" : "Custom",
"Permissions" : [ "DatabaseRead", "DatabaseChange", "DownloadFirmware" ]
}

107
GET /user

Description

List all users

Responses

HTTP Code Description Schema

200 List all users UserListResponse

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

108
GET /user/{userId}

Description

Returns the user with ID = userId

Parameters

Type Name Description Schema

userId
Path ID of the user integer
required

Responses

HTTP Code Description Schema

200 Returns the user with ID = userId UserResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

109
PATCH /user/{userId}

Description

Updates the user and returns the updated user.

NOTE this only requires a partial list of properties

Parameters

Type Name Description Schema

userId
Path ID of the user integer
required

User
Body The user JSON you want to update the user with User
required

Responses

HTTP Code Description Schema

200 Returns the updated user UserResponse

404 Not Found No Content

500 Server Error Errors

Security

Type Name

basic basicAuth

apiKey cookieAuth

110
Definitions

AggregateAddress
Name Description Schema

Represents the AFI property in the aggregate address.

AFI string
Possible values : "IPV4, IPV6"

AdvertiseMapN Represents the advertise map number property in the aggregate

integer (int32)
umber address.

AggregateAddr Represents the aggregate address number property in the

integer (int32)
essNumber aggregate address.

AttributeMapN Represents the attribute map number property in the aggregate

integer (int32)
umber address.

Option Represents the option property in the aggregate address. string

Represents the prefix address property in the aggregate

PrefixAddr string
address.

PrefixLen Represents the prefix length property in the aggregate address. integer (int32)

SAFI Represents the SAFI property in the aggregate address. string

SuppressMapN Represents the suppress map number property in the aggregate

integer (int32)
umber address.

111
ApplicationMember
Name Description Schema

Represents the application ID property in the application

ApplicationID integer (int32)
member.

Represents the application name property in the application

ApplicationNa
member. string
me
Possible values : "Default Service Profile"

ApplicationServiceGroup
Name Description Schema

Whether the allocation is relative to the CIR value for the

AllocRelToCIR boolean
Application Service Group.

AllocRelToNom Whether the allocation is relative to the nominal value for the
boolean
inal Application Service Group.

AllocRelToOpe Whether the allocation is relative to the operational value for

boolean
rational the Application Service Group.

< ApplicationMember
Applications The list of applications that are available for the service group.
> array

ConfiguredRat
The configured rates for the Application Service Group. ConfiguredRates
es

Downstream The downstream bandwidth for the Application Service Group. boolean

EffectiveRates The effective rates for the Application Service Group. EffectiveRates

Whether the EIR value is enabled for the Application Service

EnableEIR boolean
Group.

ID The unique identifier of the Application Service Group. integer

112
Name Description Schema

The minimum MODCOD value for the Application Service

Group.
Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
MinMODCOD 2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK- string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

The name of the Application Service Group.

Name string
Possible values : "Application Service Group"

ParentID The unique identifier of the parent Application Service Group. integer (int32)

The name of the parent Application Service Group.

ParentName string
Possible values : "New Network #2"

The priority of the Application Service Group.

Priority Possible values : "Cost Based, Priority Based, Best string
Effort"

Whether the CIR value is sticky for the Application Service

StickyCIR boolean
Group.

113
ConfiguredRates

Name Description Schema

The committed information rate in kilobits per second for the

CIRkbps number (double)
Application Service Group.

Cost The cost of the Application Service Group. number (double)

Whether the CIR value is enabled for the Application Service

EnableCIR boolean
Group.

Whether the MIR value is enabled for the Application Service

EnableMIR boolean
Group.

The maximum information rate in kilobits per second for the

MIRkbps number (double)
Application Service Group.

EffectiveRates

Name Description Schema

The committed information rate (CIR) in kilobits per second

CIRkbps number (double)
(kbps) that is guaranteed to be available for the service.

The modulation and coding table used to determine the

CirModcodTabl
modulation and coding scheme for the service based on the CirModcodTable
e
requested CIR.

Cost The cost of the service number (double)

The maximum information rate (MIR) in kilobits per second

MIRkbps (kbps) that can be transmitted using the modulation and coding number (double)
scheme.

The modulation and coding table used to determine the

MirModcodTab
modulation and coding scheme for the service based on the MirModcodTable
le
requested MIR.

114
CirModcodTable

Name Schema

MC_16APSK_2_3 number (double)

MC_16APSK_3_4 number (double)

MC_16APSK_4_5 number (double)

MC_16APSK_5_6 number (double)

MC_16APSK_8_9 number (double)

MC_16APSK_9_10 number (double)

MC_32APSK_3_4 number (double)

MC_32APSK_4_5 number (double)

MC_32APSK_5_6 number (double)

MC_32APSK_8_9 number (double)

MC_32APSK_9_10 number (double)

MC_8PSK_2_3 number (double)

MC_8PSK_3_4 number (double)

MC_8PSK_3_5 number (double)

MC_8PSK_5_6 number (double)

MC_8PSK_8_9 number (double)

MC_8PSK_9_10 number (double)

MC_QPSK_1_2 number (double)

MC_QPSK_1_3 number (double)

MC_QPSK_1_4 number (double)

115
Name Schema

MC_QPSK_2_3 number (double)

MC_QPSK_2_5 number (double)

MC_QPSK_3_4 number (double)

MC_QPSK_3_5 number (double)

MC_QPSK_4_5 number (double)

MC_QPSK_5_6 number (double)

MC_QPSK_8_9 number (double)

MC_QPSK_9_10 number (double)

116
MirModcodTable

Name Schema

MC_16APSK_2_3 number (double)

MC_16APSK_3_4 number (double)

MC_16APSK_4_5 number (double)

MC_16APSK_5_6 number (double)

MC_16APSK_8_9 number (double)

MC_16APSK_9_10 number (double)

MC_32APSK_3_4 number (double)

MC_32APSK_4_5 number (double)

MC_32APSK_5_6 number (double)

MC_32APSK_8_9 number (double)

MC_32APSK_9_10 number (double)

MC_8PSK_2_3 number (double)

MC_8PSK_3_4 number (double)

MC_8PSK_3_5 number (double)

MC_8PSK_5_6 number (double)

MC_8PSK_8_9 number (double)

MC_8PSK_9_10 number (double)

MC_QPSK_1_2 number (double)

MC_QPSK_1_3 number (double)

MC_QPSK_1_4 number (double)

117
Name Schema

MC_QPSK_2_3 number (double)

MC_QPSK_2_5 number (double)

MC_QPSK_3_4 number (double)

MC_QPSK_3_5 number (double)

MC_QPSK_4_5 number (double)

MC_QPSK_5_6 number (double)

MC_QPSK_8_9 number (double)

MC_QPSK_9_10 number (double)

118
ApplicationServiceGroupListItem
Name Description Schema

Downstream The downstream frequency band of the service group. boolean

ID The unique identifier of the service group. integer (int32)

Name The name of the service group. string

ParentID The unique identifier of the parent service group. integer (int32)

ParentName The name of the parent service group. string

QOSGroupType The QoS group type of the service group. string

QOSMode The Quality of Service (QoS) mode of the service group. string

ApplicationServiceGroupListResponse
Name Description Schema

<
data The list of service groups returned in the response. ApplicationServiceGr
oupListItem > array

errors Errors

meta Meta

119
ApplicationServiceGroupResponse
Name Schema

data ApplicationServiceGroup

errors Errors

meta Meta

ApplyChanges
Name Schema

Success string

ApplyChangesRequest
Name Schema

HubSide boolean

Reset boolean

Transport string

120
ApplyChangesResponse
Name Schema

data ApplyChanges

BUC
Name Description Schema

Gain The gain of the BUC. number (double)

ID The unique identifier of the Block Upconverter (BUC). integer

Manufacturer The manufacturer of the BUC. string

Name The name of the BUC. string

The unique identifier of the parent device that the BUC is

ParentID integer (int32)
associated with.

Power The power output of the BUC. number (double)

SpectralInversi The spectral inversion setting of the BUC.

string
on Possible values : "Normal, Inverted"

StartFreq The start frequency of the BUC. number (double)

StopFreq The stop frequency of the BUC. number (double)

TranslationFre
The translation frequency of the BUC. number (double)
q

TxDcEnable The transmit DC enable setting of the BUC. boolean

TxRefOscillato
The transmit reference oscillator frequency of the BUC. string
r

iDirectPartNu
The iDirect part number of the BUC. string
mber

121
BUCListItem
Name Description Schema

ID The unique identifier of the BUC. integer (int32)

Name The name of the BUC. string

BUCListResponse
Name Description Schema

data The list of BUCs returned in the response. < BUCListItem > array

errors Errors

meta Meta

BUCResponse
Name Schema

data BUC

errors Errors

meta Meta

122
CW
Name Description Schema

The BUCLOFreq property of the CW component in the

BUCLOFreq number
properties.

RFUplink The RFUplink property of the CW component in the properties. number

TXPower The TXPower property of the CW component in the properties. number

123
Carrier
Name Description Schema

The unique identifier of the bandwidth that the carrier is

BandwidthID integer (int32)
associated with.

CarrierSpacing The carrier spacing. number (double)

DownlinkFreq The downlink frequency of the carrier. number (double)

The forward error correction (FEC) rate of the carrier.

Possible values : "2D16S-100bytes (1/3), 2D16S-
100bytes (1/2), 2D16S-100bytes (2/3), 2D16S-
100bytes (3/4), 2D16S-100bytes (4/5), 2D16S-
100bytes (5/6), 2D16S-100bytes (6/7), 2D16S-
100bytes (7/8), 2D16S-170bytes (1/3), 2D16S-
170bytes (1/2), 2D16S-170bytes (2/3), 2D16S-
170bytes (2/5), 2D16S-170bytes (3/4), 2D16S-
170bytes (3/5), 2D16S-170bytes (4/5), 2D16S-
FecRate string
170bytes (5/6), 2D16S-170bytes (6/7), 2D16S-
170bytes (6/11), 2D16S-170bytes (7/8), 2D16S-
170bytes (9/10), 2D16S-438bytes (1/3), 2D16S-
438bytes (1/2), 2D16S-438bytes (2/3), 2D16S-
438bytes (2/5), 2D16S-438bytes (3/4), 2D16S-
438bytes (3/5), 2D16S-438bytes (4/5), 2D16S-
438bytes (5/6), 2D16S-438bytes (6/7), 2D16S-
438bytes (6/11), 2D16S-438bytes (7/8), 2D16S-
438bytes (9/10)"

ID The unique identifier of the carrier. integer

The inbound mode of the carrier.

InboundMode Possible values : "TDMA, ACQ, SCPC, SUPER_BURST, string
DIR_TDMA"

The maximum modulation and coding scheme of the carrier.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MaxModcod string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

124
Name Description Schema

The minimum modulation and coding scheme of the carrier.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MinModcod string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

The modulation type of the carrier.

ModulationTyp
Possible values : "BPSK, QPSK, 8PSK, 16QAM, Adaptive, string
e
Adaptive Spread"

Name The name of the carrier. string

ParentID The unique identifier of the parent carrier. integer (int32)

The power of the carrier.

Power number (double)
Possible values : -25.0

The unique identifier of the spacecraft that the carrier is

SpacecraftID integer (int32)
associated with.

SpreadAcqEna
The spread acquisition enable setting of the carrier. boolean
bled

The spreading factor of the carrier.

SpreadingFact
Possible values : "No Spreading, COTM SF=1, COTM SF=2, string
or
COTM SF=4, COTM SF=8, COTM SF=16"

Superburst The superburst setting of the carrier. boolean

SymbolRate The symbol rate of the carrier. number (double)

The unique identifier of the transponder that the carrier is

TransponderID integer (int32)
associated with.

Type Possible values : "Inroute, Outroute" string

UplinkFreq The uplink frequency of the carrier. number (double)

125
CarrierListItem
Name Description Schema

ID The unique identifier of the carrier. integer (int32)

Name The name of the carrier. string

The unique identifier of the spacecraft that the carrier is

SpacecraftID integer (int32)
associated with.

CarrierListResponse
Name Description Schema

< CarrierListItem >

data The list of carriers returned in the response.
array

errors Errors

meta Meta

CarrierResponse
Name Schema

data Carrier

errors Errors

meta Meta

126
Composition
Name Schema

ID integer (int32)

ModcodForEachCarrier < string > array

Name string

ConfigTables
Name Description Schema

AdvertiseMapN
Advertise map number in the configuration tables integer (int32)
umber

ConfigTableNu Represents the config table number property in the config

integer (int32)
mber tables.

ExportMapNu
Export map number in the configuration tables integer (int32)
mber

ImportMapNu
Import map number in the configuration tables integer (int32)
mber

NonExistMapN
Non-existent map number in the configuration tables integer (int32)
umber

DhcpClnAddrRange
Name Description Schema

EndAddr The ending address for a DHCP client address range string

StartAddr The starting address for a DHCP client address range string

127
DiscretePort
Name Description Schema

The duplex mode for a discrete port

Duplex string
Possible values : "Full, Half, Auto"

Enabled The enabled status for a discrete port boolean

The mode for a discrete port

Mode string
Possible values : "VLAN, QinQ, Access, CE-TT"

The native VLAN ID for a discrete port

NativeVLanID string
Possible values : "None"

The ethertype for the first port of a discrete port

PortEthertype1 string
Possible values : "n/a, 0x8100, 0x88A8, 0x9100"

The ethertype for the second port of a discrete port

PortEthertype2 string
Possible values : "n/a, 0x8100"

PortNumber The port number for a discrete port integer (int32)

The speed setting for a discrete port

Speed string
Possible values : "10 Mbps, 100 Mbps, 1000 Mbps, Auto"

The SvnIDs property of the DiscretePort component in the

SvnIDs < string > array
properties.

128
DownConverter
Name Description Schema

ID ID of a down converter. integer

ManufacturerI
ID of the manufacturer of a down converter. integer (int32)
D

ManufacturerP
Part number of the manufacturer of a down converter. string
N

Name Name of a down converter. string

ODURx10MHz 10MHz setting of a down converter. boolean

ODURxDCPowe
DC power setting of a down converter. boolean
r

ParentID ID of the parent device of a down converter. integer (int32)

SpectralInversi Spectral inversion setting of a down converter.

string
on Possible values : "Normal, Inverted"

Stability Stability setting of a down converter. number (double)

TranslationFre
Translation frequency of a down converter. number (double)
q

iDirectPN iDirect part number of a down converter. string

DownConverterListItem
Name Description Schema

ID ID of a down converter in a list. integer (int32)

Name Name of a down converter in a list. string

129
DownConverterListResponse
Name Description Schema

<
data Response for a list of down converters. DownConverterListIte
m > array

errors Errors

meta Meta

DownConverterResponse
Name Schema

data DownConverter

errors Errors

meta Meta

ElevationGain
Name Description Schema

The Elevation property of the ElevationGain component in the

Elevation integer (int32)
properties.

The Gain property of the ElevationGain component in the

Gain number (double)
properties.

130
Error
Name Description Schema

Message The Message property of the Error component in the properties. string

Errors
Type : < Error > array

GreTunnel
Name Description Schema

HubGateway The hub gateway for a GRE tunnel string

RemoteGatewa
The remote gateway for a GRE tunnel string
y

131
HubRFT
Name Description Schema

AntennaID ID of the antenna for a hub RF settings. integer (int32)

DownConverte
ID of the down converter for a hub RF settings. integer (int32)
rID

HPAID ID of the high power amplifier for a hub RF settings. integer (int32)

ID ID of a hub RF (Radio Frequency) settings. integer

Name Name of a hub RF settings. string

SpacecraftID ID of the spacecraft for a hub RF settings. integer (int32)

TeleportID ID of the teleport for a hub RF settings. integer (int32)

UpConverterID ID of the up converter for a hub RF settings. integer (int32)

HubRFTListItem
Name Description Schema

ID ID of a hub RF settings in a list. integer (int32)

Name Name of a hub RF settings in a list. string

132
HubRFTListResponse
Name Description Schema

< HubRFTListItem >

data Response for a list of hub RF settings.
array

errors Errors

meta Meta

HubRFTResponse
Name Schema

data HubRFT

errors Errors

meta Meta

133
InrouteGroup
Name Description Schema

Adaptive Adaptive settings for an inroute group. Adaptive

BandwidthGro < integer (int32) >

IDs of the bandwidth groups for an inroute group.
upIDs array

< integer (int32) >

CarrierIDs
array

Compositions Compositions for an inroute group. < Composition > array

ID ID of an inroute group. integer

Maximum speed for communication on the move (COTM) for an

MaxCotmSpeed integer (int32)
inroute group.

Mesh Mesh settings for an inroute group. Mesh

Name Name of an inroute group. string

NetworkID ID of the network for an inroute group. integer (int32)

QoS (Quality of Service) mode for an inroute group.

QosMode Possible values : "Remote Based, Application Scaled, string
Application Based"

Timeplan Timeplan settings for an inroute group. Timeplan

Adaptive

Name Description Schema

AllowedDropo Allowed dropout fraction for the adaptive settings of an inroute

integer (int32)
utFraction group.

ID of the default IGC (Inroute Group Composition) for the

DefaultIgcID integer (int32)
adaptive settings of an inroute group.

FixedIgcID ID of the fixed IGC for the adaptive settings of an inroute group. integer (int32)

UpdateInterval Update interval for the adaptive settings of an inroute group. integer (int32)

134
Mesh

Name Description Schema

MeshEnabled Whether the mesh is enabled for an inroute group. boolean

TxMargin Transmission margin for an inroute group. number (double)

VLansEnabled Whether VLANs are enabled for an inroute group. boolean

Timeplan

Name Description Schema

AcqAperture Acquisition aperture setting for an inroute group. number (double)

GuardInterval Guard interval setting for an inroute group. integer (int32)

InrouteGroupListItem
Name Description Schema

ID ID of an inroute group in a list. integer (int32)

Name Name of an inroute group in a list. string

NetworkID ID of a service group for a remote device. integer (int32)

135
InrouteGroupListResponse
Name Description Schema

<
data Response for a list of inroute groups. InrouteGroupListItem
> array

errors Errors

meta Meta

InrouteGroupResponse
Name Schema

data InrouteGroup

errors Errors

meta Meta

136
LNB
Name Description Schema

22KhzEnable Indicates whether the 22KHz is enabled for the LNB boolean

Gain The gain of the LNB number (double)

ID The unique identifier of an LNB integer

Manufacturer The manufacturer of the LNB string

Name The name of an LNB string

NoiseFigure The noise figure of the LNB number (double)

ParentID The unique identifier of the LNB parent integer (int32)

Rx10MHzEnabl
Indicates whether the RX 10MHz is enabled for the LNB boolean
e

RxDcEnable Indicates whether the RX DC is enabled for the LNB boolean

The RX DC voltage of the LNB

RxDcVoltage string
Possible values : "18V"

SpectralInversi The spectral inversion of the LNB

string
on Possible values : "Normal, Inverted"

StartFreq The start frequency of the LNB number (double)

StopFreq The stop frequency of the LNB number (double)

TranslationFre
The translation frequency of the LNB number (double)
q

iDirectPartNu
The iDirect part number of the LNB string
mber

LNBListItem

137
Name Description Schema

ID The unique identifier of an LNB in an LNBListResponse integer (int32)

Name The name of an LNB in an LNBListResponse string

138
LNBListResponse
Name Description Schema

data The list of LNBs returned in an LNBListResponse < LNBListItem > array

errors Errors

meta Meta

LNBResponse
Name Schema

data LNB

errors Errors

meta Meta

139
Linecard
Name Description Schema

Active The status of the Linecard boolean

AdminPasswor
The admin password for the Linecard string
d

The unique identifier of the alternate TxCarrier associated with

AltTxCarrierID integer (int32)
the Linecard

The unique identifier of the Chassis associated with the

ChassisID integer (int32)
Linecard

DID The device ID of the Linecard integer (int64)

GIG0Gateway The gateway of the GIG0 port of the Linecard string

GIG0IPAddress The IP address of the GIG0 port of the Linecard string

The speed of the GIG0 port of the Linecard

GIG0Speed string
Possible values : "10 Mbps, 100 Mbps, 1000 Mbps, Auto"

GIG0SubnetMa
The subnet mask of the GIG0 port of the Linecard string
sk

The unique identifier of the HubRFT associated with the

HubRFTID integer (int32)
Linecard

ID The unique identifier of a Linecard integer

The type of the Linecard

LinecardType Possible values : "Receive Line Card, Transmit Line string
Card, Standby"

MgmtGateway The management gateway of the Linecard string

MgmtIPAddres
The management IP address of the Linecard string
s

MgmtSubnetM
The management subnet mask of the Linecard string
ask

140
Name Description Schema

The model type of the Linecard

ModelType Possible values : "XLC-10, XLC-11, ULC-R, ULC-T, DLC- string
R, DLC-T, eM1D1"

Name The name of a Linecard string

The unique identifier of the Network associated with the

NetworkID integer (int32)
Linecard

ParentID The unique identifier of the parent of the Linecard integer (int32)

The unique identifiers of the RX Carriers associated with the

RXCarrierIds < RXCarrier > array
Linecard

The mode used for receiving communication of the Linecard

Possible values : "Single Channel SCPC, Single Channel
ReceiveMode TDMA, Multiple Channel SCPC, Multiple Channel string
TDMA, Single Channel TDMA (Adaptive), Multiple
Wide Channel TDMA, both, SCPC, DVBS2, SCPC+DVBS2"

The center frequency used for receiving communication of the

RxCenterFreq number (double)
Linecard

SN The serial number of the Linecard integer (int64)

The unique identifier of the TxCarrier associated with the

TxCarrierID integer (int32)
Linecard

UserPassword The user password for the Linecard string

141
LinecardResponse
Name Schema

data Linecard

errors Errors

meta Meta

MCGroup
Name Description Schema

The Address property of the MCGroup component in the

Address string
properties.

ID The ID property of the MCGroup component in the properties. integer (int32)

The VLanID property of the MCGroup component in the

VLanID integer (int32)
properties.

Meta
Name Description Schema

Count The Count property of the Meta component in the properties. integer (int32)

142
MulticastGroup
Name Description Schema

Address The address for a multicast group string

Interface The interface associated with a multicast group string

Network
Name Description Schema

ID The unqiue identifier of a Network integer

MulticastGrou
The multicast groups associated with the Netowkr < MCGroup > array
ps

Name The name of a Network string

ProtocolProces The unque identifier of the Protocol Processor associated with

integer (int32)
sorID the network

The unique identifier of the Teleport associated with the

TeleportID integer (int32)
Network

NetworkListItem
Name Description Schema

ID The unique identifier of a Network in a NetworkListResponse integer (int32)

Name The name of a Network in a NetworkListResponse string

The unique identifier of the Teleport associated with a Network

TeleportID integer (int32)
in a NetworkListResponse

143
NetworkListResponse
Name Description Schema

< NetworkListItem >

data The list of Networks returned in a NetworkListResponse
array

errors Errors

meta Meta

NetworkResponse
Name Schema

data Network

errors Errors

meta Meta

PN
Name Description Schema

The BUCLOFreq property of the PN component in the

BUCLOFreq number
properties.

The Modulation property of the PN component in the

Modulation string
properties.

RFUplink The RFUplink property of the PN component in the properties. number

The SymbolRate property of the PN component in the

SymbolRate number
properties.

TXPower The TXPower property of the PN component in the properties. number

144
PeerGroups
Name Description Schema

Aggregate Aggregate in the peer groups boolean

Area Area in the peer groups string

ConfigTableNu
Config table number in the peer groups integer (int32)
mber

NextHopSelf Next hop self in the peer groups boolean

PeerGroupNu
Peer group number in the peer groups integer (int32)
mber

145
Peers
Name Description Schema

ConfigTableNu
Config table number in the peers integer (int32)
mber

ConnectRetry Connect retry in the peers integer (int32)

Drop warning in the peers

DropWarn string
Possible values : "Drop, Warn"

HoldTime Hold time in the peers integer (int32)

IsReflectorClie
Reflector client in the peers boolean
nt

KeepAlive Keep alive in the peers integer (int32)

MD5AuthPassw
MD5 authentication password in the peers string
ord

MaxRoutesPee
Maximum routes per peer in the peers integer (int32)
r

NextHopSelf Next hop self in the peers boolean

Passive Passive in the peers boolean

PeerGroupNu
Peer group number in the peers integer (int32)
mber

PeerNumber Peer number in the peers integer (int32)

RemoteAS Remote AS in the peers integer (int32)

RemoteAddr Remote address in the peers string

RemotePort Remote port in the peers integer (int32)

146
PortForward
Name Description Schema

IPAddress The IP address associated with a port forwarding configuration string

PortFirst The first port in a port forwarding configuration integer (int32)

PortLast The last port in a port forwarding configuration integer (int32)

Protocol The protocol used in a port forwarding configuration string

RXCarrier
Name Description Schema

ID The ID property of the RXCarrier component in the properties. integer (int32)

The Name property of the RXCarrier component in the

Name string
properties.

147
Reflector
Name Description Schema

AntennaContro
The Antenna Controller associated with the Reflector AntennaController
ller

Controllable Indicates whether the Reflector is controllable boolean

ID The unique identifier of a Reflector integer

Name The name of a Reflector string

OffsetAngle The offset angle of the Reflector number (double)

ParentID The unique identifier of the parent Reflector integer (int32)

Size The size of the Reflector number (double)

iDirectPartNu
The iDirect part number of the Reflector string
mber

AntennaController

Name Description Schema

ControllerType The type of the Antenna Controller associated with the Reflector string

The elevation gain of the Antenna Controller associated with < ElevationGain >
ElevationGain
the Reflector array

The skew gain of the Antenna Controller associated with the

SkewGain < SkewGain > array
Reflector

148
ReflectorListItem
Name Description Schema

ID The unique identifier of a Reflector in a ReflectorListResponse integer (int32)

Name The name of a Reflector in a ReflectorListResponse string

ReflectorListResponse
Name Description Schema

< ReflectorListItem >

data The list of Reflectors returned in a ReflectorListResponse
array

errors Errors

meta Meta

ReflectorResponse
Name Schema

data Reflector

errors Errors

meta Meta

149
Remote
Name Description Schema

Active A boolean indicating whether the remote is currently active. boolean

AdminPasswor
The admin password of the remote. string
d

A boolean indicating whether Border Gateway Protocol (BGP) is

AllowBGP boolean
allowed on the remote.

AntennaCompo
The antenna components. AntennaComponents
nents

AntennaTxHan A boolean indicating whether antenna transmit handshake is

boolean
dshake enabled on the remote.

A boolean indicating whether compressed real-time protocol

CRTP boolean
(CRTP) is enabled on the remote.

CustomKeys Custom keys for the remote device. CustomKeys

Customer The customer information associated with the remote. Customer

DID The device identifier of the remote. integer (int64)

A boolean indicating whether transmit pulse width modulation

DisableTxPWM boolean
(PWM) is disabled on the remote.

DiscretePorts Discrete ports for the remote device. < DiscretePort > array

DownCIR The downlink committed information rate (CIR) of the remote. number (double)

DownMIN The downlink minimum information rate (MIN) of the remote. number (double)

DownMIR The downlink maximum information rate (MIR) of the remote. number (double)

ID The unique identifier of the remote. integer

InitialPower The initial power of the remote. number (double)

InrouteGroupI The unique identifier of the inroute group that the remote is
integer (int32)
D associated with.

150
Name Description Schema

IsMobile A boolean indicating whether the remote is mobile. boolean

IsRoaming A boolean indicating whether the remote is currently roaming. boolean

A boolean indicating whether the remote is configured for

IsSCPC boolean
single channel per carrier (SCPC) mode.

L2oS The Layer 2 over satellite (L2oS) settings of the remote. L2oS

LanGateway The LAN gateway of the remote. string

LanIPAddress The LAN IP address of the remote. string

LanSubnetMas
The LAN subnet mask of the remote. string
k

Lat The latitude of the remote. number (double)

LicenseEnforce A boolean indicating whether license enforcement is enabled

boolean
ment on the remote.

LinkEncryptio A boolean indicating whether link encryption is enabled on the

boolean
n remote.

LocalTelnetOnl A boolean indicating whether local Telnet access is the only

boolean
y method of accessing the remote.

Lon The longitude of the remote. number (double)

The modulation and coding scheme of the remote.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MODCOD string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

MaxPower The maximum power of the remote. number (double)

151
Name Description Schema

Mesh Mesh settings for the remote device. Mesh

MgmtGateway The management gateway of the remote. string

MgmtIPAddres
The management IP address of the remote. string
s

MgmtSubnetM
The management subnet mask of the remote. string
ask

Mobile Group of options used when the remote is mobile. Mobile

The model type of the remote.

Possible values : "e8350, 9350, 900, X1-Indoor, X1-
Outdoor, E150, X3, X5, X7, X7-ER, X7-EC, iConnex-
ModelType string
e800, iConnex-e850mp, 950mp, iQDesktop,
iQ200Rackmount, iQ200Board, iQLTE, SMB3315,
MDM3315"

Name The name of the remote. string

The unique identifier of the network that the remote is

NetworkID integer (int64)
associated with.

OBOLimit The out-of-band (OOB) limit of the remote. number (double)

OSPassword The operating system password of the remote. string

P1DB The 1 dB compression point of the remote. number (double)

ParentID The unique identifier of the parent remote. integer (int64)

PayloadSize The payload size of the remote. integer (int32)

License pool assignment for the iQ Remote.

PoolLicense < string > array
Possible values : [ "Security" ]

RXCarrierID The receive carrier identifier of the remote. integer (int32)

RemoteQOS Quality of Service settings for a remote device. RemoteQOS

RoamingInstan < RoamingInstance >

Roaming instances for the remote device.
ces array

152
Name Description Schema

A boolean indicating whether the remote is configured for

RxOnly boolean
receive-only mode.

RxOnlyMCTim
The receive-only multicast timeout of the remote. integer (int32)
eout

RxOnlyMultica A boolean indicating whether the remote is configured for

boolean
st receive-only multicast mode.

SCPCPeerID The unique identifier of the SCPC peer. integer (int64)

SN The serial number of the remote. integer (int64)

SecondReceive
The second receiver. SecondReceiver
r

The spreading factor of the remote.

SpreadingFact
Possible values : "No Spreading, COTM SF=1, COTM SF=2, integer (int32)
or
COTM SF=4, COTM SF=8, COTM SF=16"

SwitchPorts Switch ports for the remote device. < SwitchPort > array

SymbolRate The symbol rate of the remote. number (double)

TCPCompressio A boolean indicating whether TCP compression is enabled on

boolean
n the remote.

TXCarrierID The transmit carrier identifier of the remote. integer (int32)

TXPower The transmit power of the remote. number (double)

UDPCompressi A boolean indicating whether UDP compression is enabled on

boolean
on the remote.

UDPHdrCompr A boolean indicating whether UDP header compression is

boolean
ession enabled on the remote.

UpCIR The uplink committed information rate (CIR) of the remote. number (double)

UpMIN The uplink minimum information rate (MIN) of the remote. number (double)

UpMIR The uplink maximum information rate (MIR) of the remote. number (double)

153
Name Description Schema

UserPassword The user password of the remote. string

A boolean indicating whether VLAN tagging is enabled on the

VLanTagging boolean
remote.

VLans VLANs for the remote device. < VLanInfo > array

154
AntennaComponents

Name Description Schema

Address The address of the antenna components. string

ApproxCableLe
The approximate cable length of the antenna components. integer (int32)
ngth

BUCID The BUC ID of the antenna components. integer (int32)

BoostLnbVolta
The boost LNB voltage of the antenna components. boolean
ge

ConnectTimeo
The connect timeout of the antenna components. integer (int32)
ut

HuntFreq The hunt frequency of the antenna components. number (double)

HuntFreqSelec
The hunt frequency select of the antenna components. string
t

InitTXPowerOf
The initial transmit power offset of the antenna components. number (double)
fset

< integer (int32) >

LNBIDs The LNB IDs of the antenna components.
array

NoiseRefFreq The noise reference frequency of the antenna components. number (double)

OpenAMIPAnte OpenAMIPAntennaCo
The OpenAMIP antenna controller of the antenna components.
nnaController ntroller

OrbitSBCAnten OrbitSBCAntennaCont
The Orbit SBC antenna controller of the antenna components.
naController roller

Port The port of the antenna components. integer (int32)

The receive polarization of the antenna components.

Possible values : "Horizontal, Vertical, Right-Hand
RXPolarization Circular, Left-Hand Circular, Cross-pol, Inherit string
from Spacecraft, Inherit from Spacecraft
(Inverted)"

ReflectorID The reflector ID of the antenna components. integer (int32)

155
Name Description Schema

SeaTelDACAnt SeaTelDACAntennaCo
The SeaTel DAC antenna controller of the antenna components.
ennaController ntroller

The transmit polarization of the antenna components.

Possible values : "Horizontal, Vertical, Right-Hand
TXPolarization Circular, Left-Hand Circular, Cross-pol, Inherit string
from Spacecraft, Inherit from Spacecraft
(Inverted)"

156
OpenAMIPAntennaController

Name Description Schema

HuntBandwidt
The hunt bandwidth of the OpenAMIP antenna controller. number (double)
h

RxLocalOscilla The transmit local oscillator of the OpenAMIP antenna

number (double)
tor controller.

TxBandwidth The transmit bandwidth of the OpenAMIP antenna controller. number (double)

TxFreq The transmit frequency of the OpenAMIP antenna controller. number (double)

TxLocalOscillat The transmit local oscillator of the OpenAMIP antenna

number (double)
or controller.

OrbitSBCAntennaController

Name Description Schema

Enable22KhzTo Indicates whether the 22Khz tone is enabled for the Orbit SBC
boolean
ne antenna controller.

LNBVoltage The LNB voltage of the Orbit SBC antenna controller. integer (int32)

SeaTelDACAntennaController

Name Description Schema

DVB_FEC The DVB FEC of the SeaTel DAC antenna controller. number (double)

Enable22KhzTo Indicates whether the 22Khz tone is enabled for the SeaTel DAC
boolean
ne antenna controller.

Indicates whether DAC97 is enabled for the SeaTel DAC antenna

EnableDAC97 boolean
controller.

LNBVoltage The LNB voltage of the SeaTel DAC antenna controller. integer (int32)

NID The NID of the SeaTel DAC antenna controller. string

157
CustomKeys

Name Description Schema

HubSide Custom key for the hub side of the connection. string

RemoteSide Custom key for the remote side of the connection. string

Customer

Name Description Schema

CommissionDa
The commission date of the remote for the customer. string
te

ContractNumb The contract number of the customer associated with the

string
er remote.

Name The name of the customer associated with the remote. string

Phone The phone number of the customer associated with the remote. string

SiteNotes The site notes for the customer associated with the remote. string

158
L2oS

Name Description Schema

The bidirectional forwarding detection (BFD) settings of the

BFD boolean
L2oS.

Compression The compression settings of the L2oS. integer (int32)

The ethertype 1 of the L2oS.

Ethertype1 string
Possible values : "n/a, 0x8100, 0x88A8, 0x9100"

The ethertype 2 of the L2oS.

Ethertype2 string
Possible values : "n/a, 0x8100"

HeaderCompre
The header compression settings of the L2oS. HeaderCompression
ssion

MTU The maximum transmission unit (MTU) of the L2oS. integer (int32)

SDT The satellite data terminal (SDT) settings of the L2oS. integer (int32)

SVNs SVNs used in the L2oS. < SVN > array

HeaderCompression

Name Description Schema

CompressionTy The type of compression used in the header compression of the

string
pe L2oS.

Profiles The profiles used in the header compression of the L2oS. < string > array

159
Mesh

Name Description Schema

Mode of the mesh for the remote device.

Mode string
Possible values : "Non-Mesh, Mesh, Mesh Tx Only"

ReceiverFadeM
Fade margin of the receiver for the mesh. number (double)
argin

ReceiverHyster
Hysteresis margin of the receiver for the mesh. number (double)
esisMargin

ReceiverIPAdd
IP address of the receiver for the mesh. string
ress

ReceiverSN Serial number of the receiver for the mesh. integer (int64)

ReceiverSubne
Subnet mask of the receiver for the mesh. string
tMask

Mobile

Name Description Schema

The type of communication on-the-move (COTM) of the mobile

COTMType string
remote.

GPSInput The GPS input settings of the mobile remote. string

GPSRefreshRat
The GPS refresh rate of the mobile remote. integer (int32)
e

Handshake The handshake settings of the mobile remote. boolean

MaxSkew The maximum skew of the mobile remote. number (double)

MinLookAngle The minimum look angle of the mobile remote. number (double)

Security The security settings of the mobile remote. boolean

SerialDevice The serial device settings of the mobile remote. string

SerialSettings The serial settings of the mobile remote. string

160
Name Description Schema

SkewMargin The skew margin of the mobile remote. number (double)

161
RemoteQOS

Name Description Schema

DSAllocRelToC
Maximum MODCOD for the remote device. boolean
IR

DSDistributor Distributor settings for downstream data transmission. DSDistributor

Allocation relative to the Carrier-to-Interference Ratio (CIR) for

DSQOS DSQOS
upstream data transmission.

DSRateShaping Rate shaping settings for downstream data transmission. DSRateShaping

IdleDormant Idle and dormant settings for the remote device. IdleDormant

Represents the description of the nominal MODCOD

(Modulation and Coding Scheme) for the remote device.
Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
MaxMODCOD 2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK- string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-

1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
NominalMODC
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK- string
OD
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

USAdaptive Adaptive settings for upstream data transmission. USAdaptive

USAllocRelToCI The allocation relative to the Carrier-to-Interference Ratio (CIR)

boolean
R for upstream data transmission.

USDistributor Distributor settings for upstream data transmission. USDistributor

162
Name Description Schema

USQOS Quality of Service settings for upstream data transmission. USQOS

USRateShaping Rate shaping settings for upstream data transmission. USRateShaping

DSDistributor

Name Description Schema

Whether the distributor is enabled for downstream data

Enabled boolean
transmission.

SegmentSize Segment size for downstream data transmission. integer (int32)

163
DSQOS

Name Description Schema

FilterProfile Filter profile for downstream data transmission. string

FilterProfileID ID of the filter profile for downstream data transmission. integer (int32)

MCServiceProfi
Multicast service profile for downstream data transmission. string
le

MCServiceProfi ID of the multicast service profile for downstream data

integer (int32)
leID transmission.

QOSGroupType Type of QoS group for downstream data transmission. string

ServiceGroup Service group for downstream data transmission. string

ServiceGroupI
ID of the service group for downstream data transmission. integer (int32)
D

ServiceProfile Service profile for downstream data transmission. string

ServiceProfileI
ID of the service profile for downstream data transmission. integer (int32)
D

164
DSRateShaping

Name Description Schema

Committed information rate (CIR) for downstream data

CIR number (double)
transmission.

Cost Cost for downstream data transmission. number (double)

Whether the committed information rate (CIR) is enabled for

EnableCIR boolean
downstream data transmission.

Whether the excess information rate (EIR) is enabled for

EnableEIR boolean
downstream data transmission.

Whether the maximum information rate (IR) is enabled for

EnableMaxIR boolean
downstream data transmission.

Whether the minimum information rate (IR) is enabled for

EnableMinIR boolean
downstream data transmission.

Maximum information rate (IR) for downstream data

MaxIR number (double)
transmission.

Minimum information rate (IR) for downstream data

MinIR number (double)
transmission.

Minimum MODCOD for downstream data transmission.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MinMODCOD string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

Priority Priority for downstream data transmission. string

IdleDormant

165
Name Description Schema

DormantSlotsE
Number of slots for dormant periods for the remote device. integer (int32)
very

DormantTimeo
Timeout for dormant periods for the remote device. integer (int32)
ut

Whether the idle and dormant settings are enabled for the
Enabled boolean
remote device.

IdleSTimeout Timeout for idle periods for the remote device. integer (int32)

IdleSlotsEvery Number of slots for idle periods for the remote device. integer (int32)

166
USAdaptive

Name Description Schema

EnableMaxImp Whether the maximum impairment is enabled for upstream

boolean
airment data transmission.

Maximum carrier-to-noise ratio for upstream data

MaxCN number (double)
transmission.

MaxImpairme
Maximum impairment for upstream data transmission. number (double)
nt

MaxSymrate Maximum symbol rate for upstream data transmission. number (double)

USDistributor

Name Description Schema

Whether the distributor is enabled for upstream data

Enabled boolean
transmission.

SegmentSize Segment size for upstream data transmission. integer (int32)

167
USQOS

Name Description Schema

FilterProfile Filter profile for upstream data transmission. string

FilterProfileID ID of the filter profile for upstream data transmission. integer (int32)

QOSGroupType Type of QoS group for upstream data transmission. string

ServiceGroup Service group for upstream data transmission. string

ServiceGroupI
ID of the service group for upstream data transmission. integer (int32)
D

ServiceProfile Service profile for upstream data transmission. string

ServiceProfileI
ID of the service profile for upstream data transmission. integer (int32)
D

USRateShaping

Name Description Schema

Committed information rate (CIR) for upstream data

CIR number (double)
transmission.

Cost Cost for upstream data transmission. number (double)

Whether the committed information rate (CIR) is enabled for

EnableCIR boolean
upstream data transmission.

Whether the excess information rate (EIR) is enabled for

EnableEIR boolean
upstream data transmission.

Whether the maximum information rate (IR) is enabled for

EnableMaxIR boolean
upstream data transmission.

Whether the minimum information rate (IR) is enabled for

EnableMinIR boolean
upstream data transmission.

Maximum information rate (IR) for upstream data

MaxIR number (double)
transmission.

MinIR Minimum information rate (IR) for upstream data transmission. number (double)

168
Name Description Schema

Minimum MODCOD for upstream data transmission.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MinMODCOD string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

Priority Priority for upstream data transmission. string

169
SecondReceiver

Name Description Schema

AuthorizedMC < integer (int32) >

The authorized MCFP streams of the second receiver.
FPStreams array

Enabled Indicates whether the second receiver is enabled. boolean

RxFrequency The receive frequency of the second receiver. number (double)

SecondRxPort The second receive port of the second receiver. SecondRxPort

SymbolRate The symbol rate of the second receiver. number (double)

SecondRxPort

Name Description Schema

BoostLnbVolta
The boost LNB voltage of the second receive port. boolean
ge

IFL The intermediate frequency link of the second receive port. string

LNBID The LNB ID of the second receive port. integer (int32)

MCFPEncryptio
boolean
n

170
RemoteListItem
Name Description Schema

Active Whether a remote device is active. boolean

DID DID (Device ID) of a remote device. integer (int32)

ID ID of a remote device. integer (int32)

InrouteGroupI
ID of the inroute group for a remote device. integer (int32)
D

IsSCPC Whether a remote device is using SCPC. boolean

Model type of a remote device.

Possible values : "e8350, 9350, 900, X1-Indoor, X1-
Outdoor, E150, X3, X5, X7, X7-ER, X7-EC, iConnex-
ModelType string
e800, iConnex-e850mp, 950mp, iQDesktop,
iQ200Rackmount, iQ200Board, iQLTE, SMB3315,
MDM3315"

Name Name of a remote device. string

NetworkID ID of the network for a remote device. integer (int32)

ParentID ID of the parent device of a remote device. integer (int32)

SCPCPeerID SCPC (Single Channel Per Carrier) peer ID of a remote device. integer (int32)

SN Serial number of a remote device. string

RemoteListResponse
Name Description Schema

< RemoteListItem >

data Response for a list of remote devices.
array

errors Errors

meta Meta

171
RemoteMember
Name Description Schema

The RemoteID property of the RemoteMember component in

RemoteID integer (int32)
the properties.

The RemoteName property of the RemoteMember component

RemoteName string
in the properties.

RemoteProfileI The RemoteProfileID property of the RemoteMember

integer (int32)
D component in the properties.

RemoteResponse
Name Schema

data Remote

errors Errors

meta Meta

172
RemoteServiceGroup
Name Description Schema

AllocRelToCIR Allocation relative to the CIR for the service group. boolean

AllocRelToNom
Allocation relative to the nominal rate for the service group. boolean
inal

AllocRelToOpe
Allocation relative to the operational rate for the service group. boolean
rational

ConfiguredRat
ConfiguredRates
es

Whether the service group is for downstream data

Downstream boolean
transmission.

EffectiveRates EffectiveRates

Whether the EIR (Excess Information Rate) is enabled for the

EnableEIR boolean
service group.

ID Internal ID of the RemoteServiceGroup integer

Minimum MODCOD for the service group.

Possible values : "QPSK-1/4, QPSK-1/3, QPSK-2/5, QPSK-
1/2, QPSK-3/5, QPSK-2/3, QPSK-3/4, QPSK-4/5, QPSK-
5/6, QPSK-8/9, QPSK-9/10, 8PSK-3/5, 8PSK-2/3,
8PSK-3/4, 8PSK-5/6, 8PSK-8/9, 8PSK-9/10, 16APSK-
2/3, 16APSK-3/4, 16APSK-4/5, 16APSK-5/6, 16APSK-
MinMODCOD string
8/9, 16APSK-9/10, 32APSK-3/4, 32APSK-4/5, 32APSK-
5/6, 32APSK-8/9, 32APSK-9/10, BPSK-1/3, BPSK-1/2,
BPSK-2/3, BPSK-3/4, BPSK-4/5, BPSK-5/6, BPSK-6/7,
BPSK-7/8, QPSK-6/7, QPSK-7/8, 8PSK-1/3, 8PSK-1/2,
8PSK-4/5, 8PSK-6/7, 8PSK-7/8, 16QAM-3/4, 16QAM-
4/5, 16QAM-6/7"

Name Name of a service group for a remote device. string

ParentID ID of the parent device for the service group settings. integer (int32)

ParentName Name of the parent device for the service group settings. string

Priority Priority of the service group. string

173
Name Description Schema

RemoteWithPr < RemoteMember >

Represents the remote service group profiles.
ofiles array

StickyCIR Whether the CIR is sticky for the service group. boolean

174
ConfiguredRates

Name Schema

CIRkbps number (double)

Cost number (double)

EnableCIR boolean

EnableMIR boolean

MIRkbps number (double)

EffectiveRates

Name Description Schema

CIRkbps The committed information rate in kilobits per second. number (double)

CirModcodTabl The modulation and coding scheme table for the committed
CirModcodTable
e information rate.

Cost The cost associated with the effective rates. number (double)

MIRkbps The maximum information rate in kilobits per second. number (double)

MirModcodTab The modulation and coding scheme table for the maximum
MirModcodTable
le information rate.

175
CirModcodTable

Name Schema

MC_16APSK_2_3 number (double)

MC_16APSK_3_4 number (double)

MC_16APSK_4_5 number (double)

MC_16APSK_5_6 number (double)

MC_16APSK_8_9 number (double)

MC_16APSK_9_10 number (double)

MC_32APSK_3_4 number (double)

MC_32APSK_4_5 number (double)

MC_32APSK_5_6 number (double)

MC_32APSK_8_9 number (double)

MC_32APSK_9_10 number (double)

MC_8PSK_2_3 number (double)

MC_8PSK_3_4 number (double)

MC_8PSK_3_5 number (double)

MC_8PSK_5_6 number (double)

MC_8PSK_8_9 number (double)

MC_8PSK_9_10 number (double)

MC_QPSK_1_2 number (double)

MC_QPSK_1_3 number (double)

MC_QPSK_1_4 number (double)

176
Name Schema

MC_QPSK_2_3 number (double)

MC_QPSK_2_5 number (double)

MC_QPSK_3_4 number (double)

MC_QPSK_3_5 number (double)

MC_QPSK_4_5 number (double)

MC_QPSK_5_6 number (double)

MC_QPSK_8_9 number (double)

MC_QPSK_9_10 number (double)

177
MirModcodTable

Name Schema

MC_16APSK_2_3 number (double)

MC_16APSK_3_4 number (double)

MC_16APSK_4_5 number (double)

MC_16APSK_5_6 number (double)

MC_16APSK_8_9 number (double)

MC_16APSK_9_10 number (double)

MC_32APSK_3_4 number (double)

MC_32APSK_4_5 number (double)

MC_32APSK_5_6 number (double)

MC_32APSK_8_9 number (double)

MC_32APSK_9_10 number (double)

MC_8PSK_2_3 number (double)

MC_8PSK_3_4 number (double)

MC_8PSK_3_5 number (double)

MC_8PSK_5_6 number (double)

MC_8PSK_8_9 number (double)

MC_8PSK_9_10 number (double)

MC_QPSK_1_2 number (double)

MC_QPSK_1_3 number (double)

MC_QPSK_1_4 number (double)

178
Name Schema

MC_QPSK_2_3 number (double)

MC_QPSK_2_5 number (double)

MC_QPSK_3_4 number (double)

MC_QPSK_3_5 number (double)

MC_QPSK_4_5 number (double)

MC_QPSK_5_6 number (double)

MC_QPSK_8_9 number (double)

MC_QPSK_9_10 number (double)

179
RemoteServiceGroupListItem
Name Description Schema

Represents the downstream property in the remote service

Downstream boolean
group list item.

Represents the ID property in the remote service group list

ID integer (int32)
item.

Represents the name property in the remote service group list

Name string
item.

Represents the parent ID property in the remote service group

ParentID integer (int32)
list item.

Represents the parent name property in the remote service

ParentName string
group list item.

Represents the QOS group type property in the remote service

QOSGroupType string
group list item.

Represents the QOS mode property in the remote service group

QOSMode string
list item.

RemoteServiceGroupListResponse
Name Description Schema

<
Represents the data property in the remote service group list
data RemoteServiceGroupL
response.
istItem > array

errors Errors

meta Meta

180
RemoteServiceGroupResponse
Name Schema

data RemoteServiceGroup

errors Errors

meta Meta

RoamingInstance
Name Description Schema

ID ID in the roaming instance integer (int32)

InrouteGroupI
In-route group ID in the roaming instance integer (int32)
D

IsSCPC SCPC in the roaming instance boolean

NetworkID Network ID in the roaming instance integer (int32)

SCPCPeerID SCPC peer ID in the roaming instance integer (int32)

RoamingRemote
Name Description Schema

InrouteGroupI The unique identifier of the inroute group that the remote is
integer (int32)
D associated with.

The IsSCPC property of the RoamingRemote component in the

IsSCPC boolean
properties.

The NetworkID property of the RoamingRemote component in

NetworkID integer (int32)
the properties.

The SCPCPeerID property of the RoamingRemote component in

SCPCPeerID integer (int32)
the properties.

181
RouteMaps
Name Description Schema

RouteMapNum
Represents the route map number property in the route maps. integer (int32)
ber

Rules Represents the rules property in the route maps. < Rule > array

182
Rule
Name Description Schema

Continue Represents the continue property in the rule. integer (int32)

IPPrefix Represents the IPPrefix property in the rule. IPPrefix

MaAFI Represents the MaAFI property in the rule. string

MaASPath Represents the MaASPath property in the rule. string

MaCommunity Represents the MaCommunity property in the rule. string

MaExCommuni
Represents the MaExCommunity property in the rule. string
ty

MaMed Represents the MaMed property in the rule. integer (int32)

MaSAFI Represents the MaSAFI property in the rule. string

ORFAssociation Represents the ORFAssociation property in the rule. string

Permit Represents the permit property in the rule. boolean

RuleNumber Represents the rule number property in the rule. integer (int32)

SNRMetricRout
Represents the SNRMetricRouteMapIndex property in the rule. integer (int32)
eMapIndex

SeASAction Represents the SeASAction property in the rule. string

SeASTimes Represents the SeASTimes property in the rule. integer (int32)

SeCommunity Represents the SeCommunity property in the rule. string

SeCommunityA
Represents the SeCommunityAction property in the rule. string
ction

SeExCommunit
Represents the SeExCommunity property in the rule. string
y

SeExCommunit
Represents the SeExCommunityAction property in the rule. string
yAction

183
Name Description Schema

SeLocalPref Represents the SeLocalPref property in the rule. integer (int32)

SeMed Represents the SeMed property in the rule. integer (int32)

SeNextHopAdd
Represents the SeNextHopAddress property in the rule. string
ress

SeOrigin Represents the SeOrigin property in the rule. string

SeWeight Represents the SeWeight property in the rule. integer (int32)

184
IPPrefix

Name Description Schema

AFI Represents the AFI property in the IPPrefix property of the rule. string

Represents the address property in the IPPrefix property of the

Address string
rule.

Represents the GE value property in the IPPrefix property of the

GEValue integer (int32)
rule.

Represents the LE value property in the IPPrefix property of the

LEValue integer (int32)
rule.

Represents the length property in the IPPrefix property of the

Len integer (int32)
rule.

Represents the match property in the IPPrefix property of the

Match string
rule.

Represents the permit property in the IPPrefix property of the

Permit string
rule.

Represents the prefix number property in the IPPrefix property

PrefixNumber integer (int32)
of the rule.

Represents the SAFI property in the IPPrefix property of the

SAFI string
rule.

SVN
Name Description Schema

BGPEnabled BGP enabled in the SVN boolean

Enabled Enabled in the SVN boolean

L3 L3 in the SVN L3

LocalIdCe Local ID CE in the SVN integer (int32)

LocalIdSp Local ID SP in the SVN integer (int32)

185
Name Description Schema

SvnID SVN ID in the SVN integer (int32)

186
L3

Name Description Schema

BGP BGP in the L3 of SVN BGP

ETH0IPAddress ETH0 IP address in the L3 of SVN string

ETH0SubnetMa
ETH0 subnet mask in the L3 of SVN string
sk

SAT0IPAddress SAT0 IP address in the L3 of SVN string

SAT0SubnetMa
SAT0 subnet mask in the L3 of SVN string
sk

BGP

Name Description Schema

AS AS in the BGP of L3 in SVN integer (int32)

AggregateAddr < AggregateAddress >

Aggregate addresses in the BGP of L3 in SVN
esses array

ConfigTables Config tables in the BGP of L3 in SVN < ConfigTables > array

Enabled Enabled in the BGP of L3 in SVN boolean

ORF ORF in the BGP of L3 in SVN ORF

PeerGroups Peer groups in the BGP of L3 in SVN < PeerGroups > array

Peers Peers in the BGP of L3 in SVN < Peers > array

RemoteID Remote ID in the BGP of L3 in SVN integer (int32)

RouteMaps Route maps in the BGP of L3 in SVN < RouteMaps > array

RouteRedistrib
Route redistribution in the BGP of L3 in SVN RouteRedistribution
ution

187
ORF

Name Description Schema

Enabled Enabled in the ORF of BGP in L3 of SVN boolean

SendRecv Send/receive in the ORF of BGP in L3 of SVN string

Type string

RouteRedistribution

Name Description Schema

ConnectedRout Connected routes enabled in the route redistribution of BGP in

boolean
esEnabled L3 of SVN

RIPRoutesEnab RIP routes enabled in the route redistribution of BGP in L3 of

boolean
led SVN

StaticRoutesEn Static routes enabled in the route redistribution of BGP in L3 of

boolean
abled SVN

SkewGain
Name Description Schema

The Gain property of the SkewGain component in the

Gain number (double)
properties.

The Skew property of the SkewGain component in the

Skew integer (int32)
properties.

188
Spacecraft
Name Description Schema

ID The unique identifier of a Spacecraft integer

InclineOrbit The inclination of the orbit of the Spacecraft number (double)

Longitude The longitude of the Spacecraft number (double)

MaxSkew The maximum skew of the Spacecraft number (double)

MinimumLook
The minimum look angle of the Spacecraft number (double)
Angle

Name The name of a Spacecraft string

The unique identifier of the Operator associated with the

OperatorID integer (int32)
Spacecraft

OperatorRefNa The reference name of the Operator associated with the

string
me Spacecraft

SkewMargin The margin of the skew of the Spacecraft number (double)

SkewPolarizati
The polarization of the skew of the Spacecraft number (double)
on

StationBoxAngl
The station box angle of the Spacecraft number (double)
e

SpacecraftListItem
Name Description Schema

The unique identifier of a Spacecraft in a

ID integer (int32)
SpacecraftListResponse

Name The name of a Spacecraft in a SpacecraftListResponse string

189
SpacecraftListResponse
Name Description Schema

< SpacecraftListItem >

data The list of Spacecrafts returned in a SpacecraftListResponse
array

errors Errors

meta Meta

SpacecraftResponse
Name Schema

data Spacecraft

errors Errors

meta Meta

StaticRoute
Name Description Schema

Cost The cost associated with a static route integer (int32)

Gateway The gateway for a static route string

IPAddress The IP address for a static route string

Interface The interface for a static route string

SubnetMask The subnet mask for a static route string

190
Status
Name Description Schema

The HubSideStatus property of the Status component in the

HubSideStatus string
properties.

RemoteSideSta The RemoteSideStatus property of the Status component in the

string
tus properties.

Status The Status property of the Status component in the properties. string

StatusResponse
Name Schema

data Status

meta Meta

SwitchPort
Name Description Schema

AutoNegotiatio
The auto-negotiation feature for a switch port boolean
n

FullDuplex The full-duplex mode for a switch port boolean

PortNumber Port number in the switch port integer (int64)

Speed100Mbps The speed setting for a switch port, specifically 100 Mbps boolean

< integer (int32) >

VLanIDs VLAN IDs in the switch port
array

191
Teleport
Name Description Schema

Alt The altitude of the Teleport number (double)

BackupNMS Wether there is a backup NMS of the Teleport boolean

CfgSrvIPAddre
The IP address of the configuration server of the Teleport string
ss

EvtSrvIPAddre
The IP address of the event server of the Teleport string
ss

ID The unique identifier of a Teleport integer

Lat The latitude of the Teleport number (double)

Lon The longitude of the Teleport number (double)

Name The name of a Teleport string

NrdSrvIPAddre
The IP address of the NRD server of the Teleport string
ss

Phone The phone number of the Teleport string

TeleportListItem
Name Description Schema

ID The unique identifier of a Teleport in a TeleportListResponse integer (int32)

Latitude The latitude of a Teleport in a TeleportListResponse number (float)

Longitude The longitude of a Teleport in a TeleportListResponse number (float)

Name The name of a Teleport in a TeleportListResponse string

192
TeleportListResponse
Name Description Schema

< TeleportListItem >

data The list of Teleports returned in a TeleportListResponse
array

errors Errors

meta Meta

TeleportResponse
Name Schema

data Teleport

errors Errors

meta Meta

193
UpConverter
Name Description Schema

ID The unique identifier of an UpConverter integer

ManufacturerI
The unique identifier of the manufacturer of the UpConverter integer (int32)
D

ManufacturerP
The part number of the UpConverter from the manufacturer string
N

Name The name of an UpConverter string

ODUTx10MHz Represents the ODUTx10MHz property in the up converter. boolean

ODUTxDCPowe
Represents the ODUTxDCPower property in the up converter. boolean
r

ParentID The unique identifier of the UpConverter parent integer (int32)

SpectralInversi The spectral inversion of the UpConverter

string
on Possible values : "Normal, Inverted"

TranslationFre
The translation frequency of the UpConverter number (double)
q

iDirectPN The iDirect part number of the UpConverter string

UpConverterListItem
Name Description Schema

The unique identifier of an UpConverter in an

ID integer (int32)
UpConverterListResponse

Name The name of an UpConverter in an UpConverterListResponse string

194
UpConverterListResponse
Name Description Schema

<
The list of UpConverters returned in an
data UpConverterListItem
UpConverterListResponse
> array

errors Errors

meta Meta

UpConverterResponse
Name Schema

data UpConverter

errors Errors

meta Meta

195
User
Name Description Schema

AccessLevel The access level of the User string

ID The unique identifier of a User integer

LoginName The login name of the User string

Name The name of a User string

ParentID The unique identifier of the Users parent integer (int32)

Password The password of the User string

Permissions The permissions of the User < string > array

The unique identifier of the User Group associated with the

UserGroupID integer (int32)
User

UserListItem
Name Description Schema

ID The unique identifier of a User in a UserListResponse integer (int32)

Name The name of a User in a UserListResponse string

196
UserListResponse
Name Description Schema

data The list of Users returned in a UserListResponse < UserListItem > array

errors Errors

meta Meta

UserResponse
Name Schema

data User

errors Errors

meta Meta

197
VLanInfo
Name Description Schema

The DHCP (Dynamic Host Configuration Protocol) configuration

DHCP DHCP
for a VLAN

DNS The DNS (Domain Name System) configuration for a VLAN DNS

ETH0IPAddress The IP address for the ETH0 interface of a VLAN string

ETH0RIPv2 The RIPv2 configuration for the ETH0 interface of a VLAN boolean

ETH0SubnetMa
The subnet mask for the ETH0 interface of a VLAN string
sk

The GRE (Generic Routing Encapsulation) tunnels configuration

GreTunnels < GreTunnel > array
for a VLAN

MulticastGrou < MulticastGroup >

The multicast groups configuration for a VLAN
ps array

The NAT (Network Address Translation) configuration for a

NAT boolean
VLAN

PortForward The port forwarding configuration for a VLAN < PortForward > array

SAT0IPAddress The IP address for the SAT0 interface of a VLAN string

SAT0RIPv2 The RIPv2 configuration for the SAT0 interface of a VLAN boolean

SAT0SubnetMa
The subnet mask for the SAT0 interface of a VLAN string
sk

StaticRoutes The static routes configuration for a VLAN < StaticRoute > array

VLanID The VLAN ID for a VLAN information object integer (int64)

198
DHCP

Name Description Schema

ClientAddrRan < DhcpClnAddrRange

The client address ranges for the DHCP configuration of a VLAN
ges > array

DefaultGwAdd The default gateway address for the DHCP configuration of a

string
r VLAN

DhcpID The DHCP ID for a VLAN integer (int64)

DhcpMode The DHCP mode for the DHCP configuration of a VLAN integer (int32)

The lease duration in seconds for the DHCP configuration of a

LeaseSeconds integer (int64)
VLAN

PrimaryDnsAd
The primary DNS address for the DHCP configuration of a VLAN string
dr

RelayServer The relay server for the DHCP configuration of a VLAN string

SecondaryDns The secondary DNS address for the DHCP configuration of a

string
Addr VLAN

DNS

Name Description Schema

CacheSize The cache size for the DNS configuration of a VLAN integer (int64)

Enabled The enabled status for the DNS configuration of a VLAN boolean

FwdQSize The forward queue size for the DNS configuration of a VLAN integer (int64)

FwdTimeout The forward timeout for the DNS configuration of a VLAN integer (int64)

PrimaryAddr The primary DNS address for a VLAN string

PrimaryName The primary DNS name for a VLAN string

SecondaryAddr The secondary DNS address for a VLAN string

SecondaryNam
The secondary DNS name for a VLAN string
e

199
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

200
cookieAuth
For convenience, an HTTP cookie-based authentication mechanism is also supported. With this
authorization approach, separate requests must be 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.

Type : apiKey
Name : Session
In : HEADER

201
Appendix A

This appendix provides examples for the following dynamic APIs in the NMS-API:
• RemoteList on page 204
• MultiEdit on page 207
• MultiApply on page 210

Technical Note 203

Evolution | T0001403 | Revision 3
RemoteList

RemoteList
RemoteList filters the response By NetworkID, InrouteGroupID, or DID.
example call
curl -s -k -u admin:admin -d ' { "NetworkId" : 35, "RespondWith"
: [ "NetModemId", "NetModemNam", "NetworkId", "InrouteGroupId",
"SN", "DID", "ModelType", "ActiveStatus", "InitTxPower",
"MaxTxPower", "1DB", "RemoteAntennaId", "Lat", "Lon"i, "BucId",
"LnbIds" ] } ' -iX GET
https://127.0.0.1:443/api/v1/evo/config/obj/remote
example response
{
"RespondWith": [],
"data": [
{
"NetModemId": 2414,
"NetModemName": "New Remote #2413",
"NetworkId": 35,
"InrouteGroupId": 65,
"SN": 23213,
"DID": 234904237,
"ModelType": 140,
"ActiveStatus": 1,
"InitTxPower": -25,
"MaxTxPower": -20,
"1DB": 0,
"RemoteAntennaId": 2298,
"Lat": 1.03417,
"Lon": 5.135,
"BucId": 28,
"LnbIds": "[40]"
},
{
"NetModemId": 2426,
"NetModemName": "New Remote #2426",
"NetworkId": 35,

204 Technical Note

Evolution | T0001403 | Revision 3
 RemoteList

"InrouteGroupId": 65,
"SN": 0,
"DID": 27262976,
"ModelType": 104,
"ActiveStatus": 0,
"InitTxPower": -25,
"MaxTxPower": 0,
"1DB": 0,
"RemoteAntennaId": 2306,
"Lat": 0,
"Lon": 0,
"BucId": 0,
"LnbIds": "[0]"
},
{
"NetModemId": 2459,
"NetModemName": "Copy of New Remote #2413",
"NetworkId": 35,
"InrouteGroupId": 65,
"SN": 0,
"DID": 234881024,
"ModelType": 140,
"ActiveStatus": 0,
"InitTxPower": -25,
"MaxTxPower": -20,
"1DB": 0,
"RemoteAntennaId": 2340,
"Lat": 1.03417,
"Lon": 5.135,
"BucId": 0,
"LnbIds": "[0]"
}
],
"meta": {

Technical Note 205

Evolution | T0001403 | Revision 3
RemoteList

"count": 3
}
}

206 Technical Note

Evolution | T0001403 | Revision 3
 MultiEdit

MultiEdit
One particular use case is to increase TxPower for a set of remotes by 0.5dB instead of setting
the absolute value to say -12.5dB. The Relative-object inside MultiEdit allows doing exactly
this to the TXPower and a set of other remote attributes.
example call
curl -v -s -k -u admin:admin -d ' { "data" : { "Type" : "Remote",
"Targets" : [ 12727, 12726, 12725, 12724, 12723, 12722, 12721, 12720,
12719, 12718, 12717, 12716, 12715, 12714, 12713, 12712, 12711, 12710,
12709, 12708, 12707, 12706, 12705, 12704, 12703, 12702, 12701, 12700,
12699, 12698 ], "Relative" : { "TXPower" : 0.5 } } } ' -iX PATCH
https://127.0.0.1:443/api/v1/evo/config/obj/multiedit/remote
This API also allows you to add or remove custom keys from the existing custom keys in the
options file.
example call
This call adds "[MOBILE]\nlatlong_interval=4\n" to specified remote instances.
curl -v -s -k -u admin:admin -d ' { "data" : { "Type" : "Remote",
"Targets" : [ 12727, 12726, 12725, 12724, 12723, 12722, 12721, 12720,
12719, 12718, 12717, 12716, 12715, 12714, 12713, 12712, 12711, 12710,
12709, 12708, 12707, 12706, 12705, 12704, 12703, 12702, 12701, 12700,
12699, 12698 ], "Relative" : { "AddToHubSideCustomKey" :
"[MOBILE]\nlatlong_interval=4\n" } } } ' -iX PATCH
https://127.0.0.1:443/api/v1/evo/config/obj/multiedit/remote
The following attributes are available for Relative fields:
Remote::InitialPower
Remote::MaxPower
Remote::OneDB
Remote::AntennaComponents::InitTXPowerOffset
Remote::RemoteQOS::DSRateShaping::MaxIR
Remote::RemoteQOS::DSRateShaping::CIR
Remote::RemoteQOS::DSRateShaping::Cost
Remote::RemoteQOS::DSRateShaping::MinIR
Remote::RemoteQOS::USRateShaping::MaxIR
Remote::RemoteQOS::USRateShaping::CIR
Remote::RemoteQOS::USRateShaping::Cost
Remote::RemoteQOS::USRateShaping::MinIR
AddToHubSideCustomKey
AddToRmtSideCustomKey
RemoveFromHubSideCustomKey
RemoveFromRmtSideCustomKey
The following attributes are available for Absolute - fields:

Technical Note 207

Evolution | T0001403 | Revision 3
MultiEdit

Remote::SN
Remote::DID
Remote::ModelType
Remote::InRouteGroupID
Remote::NetworkID
Remote::Active
Remote::MgmtIPAddress
Remote::MgmtSubnetMask
Remote::MgmtGateway
Remote::LanIPAddress
Remote::LanSubnetMask
Remote::LanGateway
Remote::RXCarrierID
Remote::TXCarrierID
Remote::TCPCompression
Remote::UDPHdrCompression
Remote::UDPCompression
Remote::CRTP
Remote::LinkEncryption
Remote::UpCIR
Remote::UpMIR
Remote::UpMIN
Remote::DownCIR
Remote::DownMIR
Remote::DownMIN
Remote::AntennaID
Remote::AntennaTxHandshake
Remote::IsMobile
Remote::SCPCPeerID
Remote::IsRoaming
Remote::InitialPower
Remote::MaxPower
Remote::OneDB
Remote::RxOnly
Remote::RxOnlyMulticast
Remote::RxOnlyMulticastTimeout
Remote::Mobile::Security
Remote::Mobile::Handshake

208 Technical Note

Evolution | T0001403 | Revision 3
 MultiEdit

Remote::Mobile::GPSInput
Remote::Mobile::GPSRefreshRate
Remote::Mobile::SerialDevice
Remote::Mobile::SerialSettings
Remote::Mobile::COTMType
Remote::AddToHubSideCustomKey
Remote::AddToRmtSideCustomKey

Technical Note 209

Evolution | T0001403 | Revision 3
MultiApply

MultiApply

data='{
"Targets" : [ 1194, 107, 1227, 1228, 1229, 1230 ],
"Actions" : {
"Transport": "tcp",
"RemoteSide": false,
"Reset": false
}
}'

curl -sku TacUser:Tac43210 -d " $data " -iX PATCH

https://172.20.22.14:443/api/v1/evo/config/obj/multiapply/remote

Get MultiApply - status

curl -s -k -u TacUser:Tac43210 -iX GET
https://172.20.22.14:443/api/v1/evo/config/obj/multiapply/status

210 Technical Note

Evolution | T0001403 | Revision 3
ST Engineering iDirect
13861 Sunrise Valley Drive, Suite 300
Herndon, VA 20171-6126
+1 703.648.8000
+1 866.345.0983
www.idirect.net