@itentialopensource/adapter-nokia_nsp_network 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +0 -1
- package/.jshintrc +3 -0
- package/CALLS.md +180 -0
- package/CHANGELOG.md +16 -0
- package/CONTRIBUTING.md +1 -160
- package/ENHANCE.md +2 -2
- package/README.md +31 -22
- package/adapter.js +159 -330
- package/adapterBase.js +538 -873
- package/changelogs/changelog.md +24 -0
- package/metadata.json +47 -0
- package/package.json +23 -26
- package/pronghorn.json +474 -142
- package/propertiesSchema.json +453 -40
- package/refs?service=git-upload-pack +0 -0
- package/report/adapter-openapi.json +5914 -0
- package/report/adapter-openapi.yaml +4412 -0
- package/report/adapterInfo.json +10 -0
- package/report/updateReport1691505793463.json +120 -0
- package/report/updateReport1692203072631.json +120 -0
- package/report/updateReport1694458523470.json +120 -0
- package/report/updateReport1694467422900.json +120 -0
- package/report/updateReport1698422266328.json +120 -0
- package/sampleProperties.json +63 -2
- package/test/integration/adapterTestBasicGet.js +1 -1
- package/test/integration/adapterTestConnectivity.js +91 -42
- package/test/integration/adapterTestIntegration.js +130 -2
- package/test/unit/adapterBaseTestUnit.js +388 -313
- package/test/unit/adapterTestUnit.js +306 -109
- package/utils/adapterInfo.js +1 -1
- package/utils/addAuth.js +1 -1
- package/utils/artifactize.js +1 -1
- package/utils/checkMigrate.js +1 -1
- package/utils/entitiesToDB.js +1 -0
- package/utils/findPath.js +1 -1
- package/utils/methodDocumentor.js +71 -23
- package/utils/modify.js +13 -15
- package/utils/packModificationScript.js +1 -1
- package/utils/taskMover.js +309 -0
- package/utils/tbScript.js +3 -10
- package/utils/tbUtils.js +2 -3
- package/utils/testRunner.js +1 -1
- package/utils/troubleshootingAdapter.js +1 -3
- package/workflows/README.md +0 -3
|
@@ -0,0 +1,4412 @@
|
|
|
1
|
+
openapi: 3.0.0
|
|
2
|
+
info:
|
|
3
|
+
title: Network Supervision REST APIs
|
|
4
|
+
description: "The Network Supervision application allows users to monitor the health of objects, such as NEs, card slots, cards, ports, links or link aggregation groups, using KPIs, and monitor the fault status of a network. <br /><br />The objects returned are coming from all deployed source systems.<br /><br /><p><b>Access Information</b></p><p>Prior to accessing the API services below, the API client must authenticate the NSP user via the NSP REST Gateway's authentication API service. The api-docs for the REST Gateway can be found with the NSP Product at: </p><p>https://<server>/rest-gateway/api-docs/ - where <server> is the hostname or IP address of the installed NSP server</p><p>or via the NSP DevPortal at: </p><p><a href='https://nsp.developer.nokia.com/api-documentation/'>https://nsp.developer.nokia.com/api-documentation/</a> - you will need to create an account on the NSP DevPortal to gain access to the api-docs</p>"
|
|
5
|
+
contact: {}
|
|
6
|
+
version: '1.0'
|
|
7
|
+
servers:
|
|
8
|
+
- url: https://147.75.202.66:8544/NetworkSupervision/rest/api
|
|
9
|
+
variables: {}
|
|
10
|
+
paths:
|
|
11
|
+
/v1/cardSlots:
|
|
12
|
+
get:
|
|
13
|
+
tags:
|
|
14
|
+
- cardSlots
|
|
15
|
+
summary: getCardSlotsUsingGET
|
|
16
|
+
description: "Returns a paged list of specific card slots. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card slot. Each card slot contains a link to the installed card, if not empty. Not providing a filter will return all card slots.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card Slot <br /><strong>neId:</strong> The id of the Network Element containing the Card Slot<br /><strong>description:</strong> The detailed description of the Card Slot <br /><strong>positionId:</strong> The relative position of the Card Slot that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card Slot within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card Slot is in this state <br /><strong>objectDetails:</strong> Generic properties of the Card Slot <br /><strong>manufacturer:</strong> The vendor of the Card Slot <br /><strong>serialNumber:</strong> The serial number of the Card Slot provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card Slot provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card Slot provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card Slot <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card Slot provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card Slot <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card Slot <br /><strong>provisionedType:</strong> The type of Card provisioned in the Card Slot <br /><strong>actualType:</strong> The type of Card present in the Card Slot <br /><strong>holderState:</strong> The status of the Card Slot <br /><br />Examples:<br />Get all card slots: GET /v1/cardSlots<br />Get all card slots, using a comma-separated list of FDNs: GET /v1/cardSlots?fdns=fdn:model:equipment:EquipmentHolder:2127,fdn:model:equipment:EquipmentHolder:2128<br />Get all card slots, with filter by holderState: GET /v1/cardSlots?filter=holderState%3D'installedAndExpected'<br />Get all card slots, with filter by provisionedType: GET /v1/cardSlots?filter=NOT%20(provisionedType%20LIKE%20'%25IOM%25')<br />Get all card slots, with filter by combined criteria: GET /v1/cardSlots?filter=holderState%3D'installedAndExpected'%20AND%20NOT%20(provisionedType%20LIKE%20'%25IOM%25')"
|
|
17
|
+
operationId: getCardSlotsUsingGET
|
|
18
|
+
parameters:
|
|
19
|
+
- name: fdns
|
|
20
|
+
in: query
|
|
21
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
22
|
+
style: form
|
|
23
|
+
explode: true
|
|
24
|
+
schema:
|
|
25
|
+
type: string
|
|
26
|
+
- name: filter
|
|
27
|
+
in: query
|
|
28
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
29
|
+
style: form
|
|
30
|
+
explode: true
|
|
31
|
+
schema:
|
|
32
|
+
type: string
|
|
33
|
+
- name: limit
|
|
34
|
+
in: query
|
|
35
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
36
|
+
style: form
|
|
37
|
+
explode: true
|
|
38
|
+
schema:
|
|
39
|
+
type: integer
|
|
40
|
+
format: int32
|
|
41
|
+
default: 300
|
|
42
|
+
- name: offset
|
|
43
|
+
in: query
|
|
44
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
45
|
+
style: form
|
|
46
|
+
explode: true
|
|
47
|
+
schema:
|
|
48
|
+
type: integer
|
|
49
|
+
format: int32
|
|
50
|
+
default: 0
|
|
51
|
+
responses:
|
|
52
|
+
'200':
|
|
53
|
+
description: OK - Request executed successfully
|
|
54
|
+
headers: {}
|
|
55
|
+
content:
|
|
56
|
+
application/json:
|
|
57
|
+
schema:
|
|
58
|
+
type: array
|
|
59
|
+
items:
|
|
60
|
+
$ref: '#/components/schemas/CardSlot'
|
|
61
|
+
description: ''
|
|
62
|
+
'400':
|
|
63
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
64
|
+
headers: {}
|
|
65
|
+
content: {}
|
|
66
|
+
'401':
|
|
67
|
+
description: Unauthorized - Authentication rejected
|
|
68
|
+
headers: {}
|
|
69
|
+
content: {}
|
|
70
|
+
'404':
|
|
71
|
+
description: Not Found - URL or resource does not exist
|
|
72
|
+
headers: {}
|
|
73
|
+
content: {}
|
|
74
|
+
'405':
|
|
75
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
76
|
+
headers: {}
|
|
77
|
+
content: {}
|
|
78
|
+
'500':
|
|
79
|
+
description: Internal Server Error - Server error
|
|
80
|
+
headers: {}
|
|
81
|
+
content: {}
|
|
82
|
+
deprecated: false
|
|
83
|
+
security:
|
|
84
|
+
- RESTToken:
|
|
85
|
+
- global
|
|
86
|
+
/v1/cardSlots/{cardSlotFdn}:
|
|
87
|
+
get:
|
|
88
|
+
tags:
|
|
89
|
+
- cardSlots
|
|
90
|
+
summary: getCardSlotUsingGET
|
|
91
|
+
description: Returns detailed information for the specified card slot, which contains a link to the installed card, if not empty.<br /><br />Example:<br />GET /v1/cardSlots/fdn:model:equipment:EquipmentHolder:2127
|
|
92
|
+
operationId: getCardSlotUsingGET
|
|
93
|
+
parameters:
|
|
94
|
+
- name: cardSlotFdn
|
|
95
|
+
in: path
|
|
96
|
+
description: cardSlotFdn
|
|
97
|
+
required: true
|
|
98
|
+
style: simple
|
|
99
|
+
schema:
|
|
100
|
+
type: string
|
|
101
|
+
responses:
|
|
102
|
+
'200':
|
|
103
|
+
description: OK - Request executed successfully
|
|
104
|
+
headers: {}
|
|
105
|
+
content:
|
|
106
|
+
application/json:
|
|
107
|
+
schema:
|
|
108
|
+
$ref: '#/components/schemas/CardSlot'
|
|
109
|
+
'400':
|
|
110
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
111
|
+
headers: {}
|
|
112
|
+
content: {}
|
|
113
|
+
'401':
|
|
114
|
+
description: Unauthorized - Authentication rejected
|
|
115
|
+
headers: {}
|
|
116
|
+
content: {}
|
|
117
|
+
'403':
|
|
118
|
+
description: Forbidden - No user access to the resource
|
|
119
|
+
headers: {}
|
|
120
|
+
content: {}
|
|
121
|
+
'404':
|
|
122
|
+
description: Not Found - URL or resource does not exist
|
|
123
|
+
headers: {}
|
|
124
|
+
content: {}
|
|
125
|
+
'405':
|
|
126
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
127
|
+
headers: {}
|
|
128
|
+
content: {}
|
|
129
|
+
'422':
|
|
130
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
131
|
+
headers: {}
|
|
132
|
+
content: {}
|
|
133
|
+
'500':
|
|
134
|
+
description: Internal Server Error - Server error
|
|
135
|
+
headers: {}
|
|
136
|
+
content: {}
|
|
137
|
+
deprecated: false
|
|
138
|
+
security:
|
|
139
|
+
- RESTToken:
|
|
140
|
+
- global
|
|
141
|
+
/v1/cards:
|
|
142
|
+
get:
|
|
143
|
+
tags:
|
|
144
|
+
- cards
|
|
145
|
+
summary: getCardsUsingGET
|
|
146
|
+
description: "Returns a paged list of specific cards. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state <br /><strong>objectDetails:</strong> Generic properties of the Card <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card <br /><br />Examples:<br />Get all cards: GET /v1/cards<br />Get all cards, using a comma-separated list of FDNs: GET /v1/cards?fdns=fdn:model:equipment:Equipment:2184,fdn:model:equipment:Equipment:2186<br />Get all cards, with filter by manufacturerAssemblyNumber: GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25'<br />Get all cards, with filter by partNumber: GET /v1/cards?filter=partNumber%3D'c18e522906354010bb21e4b78b2ca014'<br />Get all cards, with filter by combined criteria: GET /v1/cards?filter=manufacturerAssemblyNumber%20LIKE%20'%252345%25'%20AND%20partNumber%3D'c18e522906354010bb21e4b78b2ca014'"
|
|
147
|
+
operationId: getCardsUsingGET
|
|
148
|
+
parameters:
|
|
149
|
+
- name: fdns
|
|
150
|
+
in: query
|
|
151
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
152
|
+
style: form
|
|
153
|
+
explode: true
|
|
154
|
+
schema:
|
|
155
|
+
type: string
|
|
156
|
+
- name: filter
|
|
157
|
+
in: query
|
|
158
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
159
|
+
style: form
|
|
160
|
+
explode: true
|
|
161
|
+
schema:
|
|
162
|
+
type: string
|
|
163
|
+
- name: limit
|
|
164
|
+
in: query
|
|
165
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
166
|
+
style: form
|
|
167
|
+
explode: true
|
|
168
|
+
schema:
|
|
169
|
+
type: integer
|
|
170
|
+
format: int32
|
|
171
|
+
default: 300
|
|
172
|
+
- name: offset
|
|
173
|
+
in: query
|
|
174
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
175
|
+
style: form
|
|
176
|
+
explode: true
|
|
177
|
+
schema:
|
|
178
|
+
type: integer
|
|
179
|
+
format: int32
|
|
180
|
+
default: 0
|
|
181
|
+
responses:
|
|
182
|
+
'200':
|
|
183
|
+
description: OK - Request executed successfully
|
|
184
|
+
headers: {}
|
|
185
|
+
content:
|
|
186
|
+
application/json:
|
|
187
|
+
schema:
|
|
188
|
+
type: array
|
|
189
|
+
items:
|
|
190
|
+
$ref: '#/components/schemas/Card'
|
|
191
|
+
description: ''
|
|
192
|
+
'400':
|
|
193
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
194
|
+
headers: {}
|
|
195
|
+
content: {}
|
|
196
|
+
'401':
|
|
197
|
+
description: Unauthorized - Authentication rejected
|
|
198
|
+
headers: {}
|
|
199
|
+
content: {}
|
|
200
|
+
'404':
|
|
201
|
+
description: Not Found - URL or resource does not exist
|
|
202
|
+
headers: {}
|
|
203
|
+
content: {}
|
|
204
|
+
'405':
|
|
205
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
206
|
+
headers: {}
|
|
207
|
+
content: {}
|
|
208
|
+
'500':
|
|
209
|
+
description: Internal Server Error - Server error
|
|
210
|
+
headers: {}
|
|
211
|
+
content: {}
|
|
212
|
+
deprecated: false
|
|
213
|
+
security:
|
|
214
|
+
- RESTToken:
|
|
215
|
+
- global
|
|
216
|
+
/v1/cards/{cardFdn}:
|
|
217
|
+
get:
|
|
218
|
+
tags:
|
|
219
|
+
- cards
|
|
220
|
+
summary: getCardUsingGET
|
|
221
|
+
description: Returns detailed information for the specified card.<br /><br />Example:<br />GET /v1/cards/fdn:model:equipment:Equipment:2184
|
|
222
|
+
operationId: getCardUsingGET
|
|
223
|
+
parameters:
|
|
224
|
+
- name: cardFdn
|
|
225
|
+
in: path
|
|
226
|
+
description: cardFdn
|
|
227
|
+
required: true
|
|
228
|
+
style: simple
|
|
229
|
+
schema:
|
|
230
|
+
type: string
|
|
231
|
+
responses:
|
|
232
|
+
'200':
|
|
233
|
+
description: OK - Request executed successfully
|
|
234
|
+
headers: {}
|
|
235
|
+
content:
|
|
236
|
+
application/json:
|
|
237
|
+
schema:
|
|
238
|
+
$ref: '#/components/schemas/Card'
|
|
239
|
+
'400':
|
|
240
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
241
|
+
headers: {}
|
|
242
|
+
content: {}
|
|
243
|
+
'401':
|
|
244
|
+
description: Unauthorized - Authentication rejected
|
|
245
|
+
headers: {}
|
|
246
|
+
content: {}
|
|
247
|
+
'403':
|
|
248
|
+
description: Forbidden - No user access to the resource
|
|
249
|
+
headers: {}
|
|
250
|
+
content: {}
|
|
251
|
+
'404':
|
|
252
|
+
description: Not Found - URL or resource does not exist
|
|
253
|
+
headers: {}
|
|
254
|
+
content: {}
|
|
255
|
+
'405':
|
|
256
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
257
|
+
headers: {}
|
|
258
|
+
content: {}
|
|
259
|
+
'422':
|
|
260
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
261
|
+
headers: {}
|
|
262
|
+
content: {}
|
|
263
|
+
'500':
|
|
264
|
+
description: Internal Server Error - Server error
|
|
265
|
+
headers: {}
|
|
266
|
+
content: {}
|
|
267
|
+
deprecated: false
|
|
268
|
+
security:
|
|
269
|
+
- RESTToken:
|
|
270
|
+
- global
|
|
271
|
+
/v1/lags:
|
|
272
|
+
get:
|
|
273
|
+
tags:
|
|
274
|
+
- lags
|
|
275
|
+
summary: getLAGsUsingGET
|
|
276
|
+
description: "Returns a paged list of specific LAGs. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of this LAG <br /><strong>neId:</strong> The id of this LAG<br /><strong>description:</strong> The detailed description of this LAG <br /><strong>configuredAddress:</strong> The MAC Address of this LAG <br /><strong>encapType:</strong> The encapsulation type of this LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for this LAG<br /><strong>operationalSpeed:</strong> The total operational speed of this LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the LAG is in this state <br /><strong>objectDetails:</strong> Generic properties of this LAG <br /><br />Examples:<br />Get all LAGs: GET /v1/lags<br />Get all LAGs, using a comma-separated list of FDNs: GET /v1/lags?fdns=fdn:model:equipment:LAG:12872,fdn:model:equipment:LAG:12873<br />Get all LAGs, with filter by configuredAddress: GET /v1/lags?filter=configuredAddress%20LIKE%20'C0-3E%25'<br />Get all LAGs, with filter by neId: GET /v1/lags?filter=neId%20LIKE%20'%25.85'<br />Get all LAGs, with filter by combined criteria: GET /v1/lags?filter=NOT%20(configuredAddress%20LIKE%20'C0-3E%25')%20AND%20neId%20LIKE%20'%25.85'"
|
|
277
|
+
operationId: getLAGsUsingGET
|
|
278
|
+
parameters:
|
|
279
|
+
- name: fdns
|
|
280
|
+
in: query
|
|
281
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
282
|
+
style: form
|
|
283
|
+
explode: true
|
|
284
|
+
schema:
|
|
285
|
+
type: string
|
|
286
|
+
- name: filter
|
|
287
|
+
in: query
|
|
288
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
289
|
+
style: form
|
|
290
|
+
explode: true
|
|
291
|
+
schema:
|
|
292
|
+
type: string
|
|
293
|
+
- name: limit
|
|
294
|
+
in: query
|
|
295
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
296
|
+
style: form
|
|
297
|
+
explode: true
|
|
298
|
+
schema:
|
|
299
|
+
type: integer
|
|
300
|
+
format: int32
|
|
301
|
+
default: 300
|
|
302
|
+
- name: offset
|
|
303
|
+
in: query
|
|
304
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
305
|
+
style: form
|
|
306
|
+
explode: true
|
|
307
|
+
schema:
|
|
308
|
+
type: integer
|
|
309
|
+
format: int32
|
|
310
|
+
default: 0
|
|
311
|
+
responses:
|
|
312
|
+
'200':
|
|
313
|
+
description: OK - Request executed successfully
|
|
314
|
+
headers: {}
|
|
315
|
+
content:
|
|
316
|
+
application/json:
|
|
317
|
+
schema:
|
|
318
|
+
type: array
|
|
319
|
+
items:
|
|
320
|
+
$ref: '#/components/schemas/LAG'
|
|
321
|
+
description: ''
|
|
322
|
+
'400':
|
|
323
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
324
|
+
headers: {}
|
|
325
|
+
content: {}
|
|
326
|
+
'401':
|
|
327
|
+
description: Unauthorized - Authentication rejected
|
|
328
|
+
headers: {}
|
|
329
|
+
content: {}
|
|
330
|
+
'404':
|
|
331
|
+
description: Not Found - URL or resource does not exist
|
|
332
|
+
headers: {}
|
|
333
|
+
content: {}
|
|
334
|
+
'405':
|
|
335
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
336
|
+
headers: {}
|
|
337
|
+
content: {}
|
|
338
|
+
'500':
|
|
339
|
+
description: Internal Server Error - Server error
|
|
340
|
+
headers: {}
|
|
341
|
+
content: {}
|
|
342
|
+
deprecated: false
|
|
343
|
+
security:
|
|
344
|
+
- RESTToken:
|
|
345
|
+
- global
|
|
346
|
+
/v1/lags/{lagFdn}:
|
|
347
|
+
get:
|
|
348
|
+
tags:
|
|
349
|
+
- lags
|
|
350
|
+
summary: getLAGUsingGET
|
|
351
|
+
description: Returns detailed information for the specified LAG.<br /><br />Example:<br />GET /v1/lags/fdn:model:equipment:LAG:12872
|
|
352
|
+
operationId: getLAGUsingGET
|
|
353
|
+
parameters:
|
|
354
|
+
- name: lagFdn
|
|
355
|
+
in: path
|
|
356
|
+
description: lagFdn
|
|
357
|
+
required: true
|
|
358
|
+
style: simple
|
|
359
|
+
schema:
|
|
360
|
+
type: string
|
|
361
|
+
responses:
|
|
362
|
+
'200':
|
|
363
|
+
description: OK - Request executed successfully
|
|
364
|
+
headers: {}
|
|
365
|
+
content:
|
|
366
|
+
application/json:
|
|
367
|
+
schema:
|
|
368
|
+
$ref: '#/components/schemas/LAG'
|
|
369
|
+
'400':
|
|
370
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
371
|
+
headers: {}
|
|
372
|
+
content: {}
|
|
373
|
+
'401':
|
|
374
|
+
description: Unauthorized - Authentication rejected
|
|
375
|
+
headers: {}
|
|
376
|
+
content: {}
|
|
377
|
+
'403':
|
|
378
|
+
description: Forbidden - No user access to the resource
|
|
379
|
+
headers: {}
|
|
380
|
+
content: {}
|
|
381
|
+
'404':
|
|
382
|
+
description: Not Found - URL or resource does not exist
|
|
383
|
+
headers: {}
|
|
384
|
+
content: {}
|
|
385
|
+
'405':
|
|
386
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
387
|
+
headers: {}
|
|
388
|
+
content: {}
|
|
389
|
+
'422':
|
|
390
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
391
|
+
headers: {}
|
|
392
|
+
content: {}
|
|
393
|
+
'500':
|
|
394
|
+
description: Internal Server Error - Server error
|
|
395
|
+
headers: {}
|
|
396
|
+
content: {}
|
|
397
|
+
deprecated: false
|
|
398
|
+
security:
|
|
399
|
+
- RESTToken:
|
|
400
|
+
- global
|
|
401
|
+
/v1/networkElements:
|
|
402
|
+
get:
|
|
403
|
+
tags:
|
|
404
|
+
- networkElements
|
|
405
|
+
summary: getNEsUsingGET
|
|
406
|
+
description: "Returns a paged list of specific network elements. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting network element. Not providing a filter will return all network elements.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of this Network Element, as defined by the source system <br /><strong>neName:</strong> The name of the Network Element which is unique within the source system<br /><strong>neId:</strong> The id of the Network Element <br /><strong>description:</strong> The detailed description of the Network Element <br /><strong>ipAddress:</strong> The management IP address of the Network Element <br /><strong>type:</strong> The type of the Network Element <br /><strong>product:</strong> The vendor product name of the Network Element <br /><strong>version:</strong> The version of the Network Element <br /><strong>resyncState:</strong> The resynchronization status of the Network Element <br /><strong>longitude:</strong> The longitude (in degrees) of the Network Element, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the Network Element, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the Network Element <br /><strong>topologyGroup:</strong> The Fully Distinguished Name of the topology group that the Network Element belongs to, if any <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the Network Element <br /><strong>networkType:</strong> The type of network the Network Element is part of <br /><strong>communicationState:</strong> The communication status of the Network Element <br /><strong>communicationStateDetails:</strong> The reachability status of each supported management protocol of the Network Element <br /><strong>macAddress:</strong> The Mac address of the Network Element <br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />Get all network elements: GET /v1/networkElements<br />Get all network elements, using a comma-separated list of FDNs: GET /v1/networkElements?fdns=fdn:model:equipment:NetworkElement:2102,fdn:model:equipment:NetworkElement:2103<br />Get all network elements, with filter by managedState: GET /v1/networkElements?filter=managedState%3D'managed'<br />Get all network elements, with filter by product: GET /v1/networkElements?filter=product%20LIKE%20'7750%25'<br />Get all network elements, with filter by combined criteria: GET /v1/networkElements?filter=managedState%3D'managed'%20AND%20NOT%20(product%20LIKE%20'7750%25')"
|
|
407
|
+
operationId: getNEsUsingGET
|
|
408
|
+
parameters:
|
|
409
|
+
- name: fdns
|
|
410
|
+
in: query
|
|
411
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
412
|
+
style: form
|
|
413
|
+
explode: true
|
|
414
|
+
schema:
|
|
415
|
+
type: string
|
|
416
|
+
- name: filter
|
|
417
|
+
in: query
|
|
418
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
419
|
+
style: form
|
|
420
|
+
explode: true
|
|
421
|
+
schema:
|
|
422
|
+
type: string
|
|
423
|
+
- name: limit
|
|
424
|
+
in: query
|
|
425
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
426
|
+
style: form
|
|
427
|
+
explode: true
|
|
428
|
+
schema:
|
|
429
|
+
type: integer
|
|
430
|
+
format: int32
|
|
431
|
+
default: 300
|
|
432
|
+
- name: offset
|
|
433
|
+
in: query
|
|
434
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
435
|
+
style: form
|
|
436
|
+
explode: true
|
|
437
|
+
schema:
|
|
438
|
+
type: integer
|
|
439
|
+
format: int32
|
|
440
|
+
default: 0
|
|
441
|
+
responses:
|
|
442
|
+
'200':
|
|
443
|
+
description: OK - Request executed successfully
|
|
444
|
+
headers: {}
|
|
445
|
+
content:
|
|
446
|
+
application/json:
|
|
447
|
+
schema:
|
|
448
|
+
type: array
|
|
449
|
+
items:
|
|
450
|
+
$ref: '#/components/schemas/NetworkElement'
|
|
451
|
+
description: ''
|
|
452
|
+
'400':
|
|
453
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
454
|
+
headers: {}
|
|
455
|
+
content: {}
|
|
456
|
+
'401':
|
|
457
|
+
description: Unauthorized - Authentication rejected
|
|
458
|
+
headers: {}
|
|
459
|
+
content: {}
|
|
460
|
+
'404':
|
|
461
|
+
description: Not Found - URL or resource does not exist
|
|
462
|
+
headers: {}
|
|
463
|
+
content: {}
|
|
464
|
+
'405':
|
|
465
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
466
|
+
headers: {}
|
|
467
|
+
content: {}
|
|
468
|
+
'500':
|
|
469
|
+
description: Internal Server Error - Server error
|
|
470
|
+
headers: {}
|
|
471
|
+
content: {}
|
|
472
|
+
deprecated: false
|
|
473
|
+
security:
|
|
474
|
+
- RESTToken:
|
|
475
|
+
- global
|
|
476
|
+
/v1/networkElements/{networkElementFdn}:
|
|
477
|
+
get:
|
|
478
|
+
tags:
|
|
479
|
+
- networkElements
|
|
480
|
+
summary: getNEUsingGET
|
|
481
|
+
description: Returns detailed information for the specified network element.<br /><br />Example:<br />GET /v1/networkElements/fdn:model:equipment:NetworkElement:2102
|
|
482
|
+
operationId: getNEUsingGET
|
|
483
|
+
parameters:
|
|
484
|
+
- name: networkElementFdn
|
|
485
|
+
in: path
|
|
486
|
+
description: networkElementFdn
|
|
487
|
+
required: true
|
|
488
|
+
style: simple
|
|
489
|
+
schema:
|
|
490
|
+
type: string
|
|
491
|
+
responses:
|
|
492
|
+
'200':
|
|
493
|
+
description: OK - Request executed successfully
|
|
494
|
+
headers: {}
|
|
495
|
+
content:
|
|
496
|
+
application/json:
|
|
497
|
+
schema:
|
|
498
|
+
$ref: '#/components/schemas/NetworkElement'
|
|
499
|
+
'400':
|
|
500
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
501
|
+
headers: {}
|
|
502
|
+
content: {}
|
|
503
|
+
'401':
|
|
504
|
+
description: Unauthorized - Authentication rejected
|
|
505
|
+
headers: {}
|
|
506
|
+
content: {}
|
|
507
|
+
'403':
|
|
508
|
+
description: Forbidden - No user access to the resource
|
|
509
|
+
headers: {}
|
|
510
|
+
content: {}
|
|
511
|
+
'404':
|
|
512
|
+
description: Not Found - URL or resource does not exist
|
|
513
|
+
headers: {}
|
|
514
|
+
content: {}
|
|
515
|
+
'405':
|
|
516
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
517
|
+
headers: {}
|
|
518
|
+
content: {}
|
|
519
|
+
'422':
|
|
520
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
521
|
+
headers: {}
|
|
522
|
+
content: {}
|
|
523
|
+
'500':
|
|
524
|
+
description: Internal Server Error - Server error
|
|
525
|
+
headers: {}
|
|
526
|
+
content: {}
|
|
527
|
+
deprecated: false
|
|
528
|
+
security:
|
|
529
|
+
- RESTToken:
|
|
530
|
+
- global
|
|
531
|
+
/v1/networkElements/{networkElementFdn}/lags:
|
|
532
|
+
get:
|
|
533
|
+
tags:
|
|
534
|
+
- networkElements
|
|
535
|
+
summary: getNELAGsUsingGET
|
|
536
|
+
description: 'Returns a list of specific LAGs. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the LAG, as defined by the source system <br /><strong>neName:</strong> The name of the LAG which is unique within the source system<br /><strong>neId:</strong> The id of the LAG <br /><strong>description:</strong> The detailed description of the LAG <br /><strong>configuredAddress:</strong> The MAC Address of the LAG <br /><strong>encapType:</strong> The encapsulation type of the LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for the LAG<br /><strong>operationalSpeed:</strong> The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the LAG <br /><br />Examples:<br />'
|
|
537
|
+
operationId: getNELAGsUsingGET
|
|
538
|
+
parameters:
|
|
539
|
+
- name: filter
|
|
540
|
+
in: query
|
|
541
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
542
|
+
style: form
|
|
543
|
+
explode: true
|
|
544
|
+
schema:
|
|
545
|
+
type: string
|
|
546
|
+
- name: networkElementFdn
|
|
547
|
+
in: path
|
|
548
|
+
description: networkElementFdn
|
|
549
|
+
required: true
|
|
550
|
+
style: simple
|
|
551
|
+
schema:
|
|
552
|
+
type: string
|
|
553
|
+
responses:
|
|
554
|
+
'200':
|
|
555
|
+
description: OK - Request executed successfully
|
|
556
|
+
headers: {}
|
|
557
|
+
content:
|
|
558
|
+
application/json:
|
|
559
|
+
schema:
|
|
560
|
+
type: array
|
|
561
|
+
items:
|
|
562
|
+
$ref: '#/components/schemas/LAG'
|
|
563
|
+
description: ''
|
|
564
|
+
'400':
|
|
565
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
566
|
+
headers: {}
|
|
567
|
+
content: {}
|
|
568
|
+
'401':
|
|
569
|
+
description: Unauthorized - Authentication rejected
|
|
570
|
+
headers: {}
|
|
571
|
+
content: {}
|
|
572
|
+
'403':
|
|
573
|
+
description: Forbidden - No user access to the resource
|
|
574
|
+
headers: {}
|
|
575
|
+
content: {}
|
|
576
|
+
'404':
|
|
577
|
+
description: Not Found - URL or resource does not exist
|
|
578
|
+
headers: {}
|
|
579
|
+
content: {}
|
|
580
|
+
'405':
|
|
581
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
582
|
+
headers: {}
|
|
583
|
+
content: {}
|
|
584
|
+
'422':
|
|
585
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
586
|
+
headers: {}
|
|
587
|
+
content: {}
|
|
588
|
+
'500':
|
|
589
|
+
description: Internal Server Error - Server error
|
|
590
|
+
headers: {}
|
|
591
|
+
content: {}
|
|
592
|
+
deprecated: false
|
|
593
|
+
security:
|
|
594
|
+
- RESTToken:
|
|
595
|
+
- global
|
|
596
|
+
/v1/networkElements/{networkElementFdn}/lags/{lagFdn}/lagMembers:
|
|
597
|
+
get:
|
|
598
|
+
tags:
|
|
599
|
+
- networkElements
|
|
600
|
+
summary: getLagMembersUsingGET
|
|
601
|
+
description: Returns a list of specific LAG members. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members.<br /><br />Examples:<br />
|
|
602
|
+
operationId: getLagMembersUsingGET
|
|
603
|
+
parameters:
|
|
604
|
+
- name: filter
|
|
605
|
+
in: query
|
|
606
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
607
|
+
style: form
|
|
608
|
+
explode: true
|
|
609
|
+
schema:
|
|
610
|
+
type: string
|
|
611
|
+
- name: lagFdn
|
|
612
|
+
in: path
|
|
613
|
+
description: lagFdn
|
|
614
|
+
required: true
|
|
615
|
+
style: simple
|
|
616
|
+
schema:
|
|
617
|
+
type: string
|
|
618
|
+
- name: networkElementFdn
|
|
619
|
+
in: path
|
|
620
|
+
description: networkElementFdn
|
|
621
|
+
required: true
|
|
622
|
+
style: simple
|
|
623
|
+
schema:
|
|
624
|
+
type: string
|
|
625
|
+
responses:
|
|
626
|
+
'200':
|
|
627
|
+
description: OK - Request executed successfully
|
|
628
|
+
headers: {}
|
|
629
|
+
content:
|
|
630
|
+
application/json:
|
|
631
|
+
schema:
|
|
632
|
+
type: array
|
|
633
|
+
items:
|
|
634
|
+
$ref: '#/components/schemas/LAGMemberDetails'
|
|
635
|
+
description: ''
|
|
636
|
+
'400':
|
|
637
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
638
|
+
headers: {}
|
|
639
|
+
content: {}
|
|
640
|
+
'401':
|
|
641
|
+
description: Unauthorized - Authentication rejected
|
|
642
|
+
headers: {}
|
|
643
|
+
content: {}
|
|
644
|
+
'403':
|
|
645
|
+
description: Forbidden - No user access to the resource
|
|
646
|
+
headers: {}
|
|
647
|
+
content: {}
|
|
648
|
+
'404':
|
|
649
|
+
description: Not Found - URL or resource does not exist
|
|
650
|
+
headers: {}
|
|
651
|
+
content: {}
|
|
652
|
+
'405':
|
|
653
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
654
|
+
headers: {}
|
|
655
|
+
content: {}
|
|
656
|
+
'422':
|
|
657
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
658
|
+
headers: {}
|
|
659
|
+
content: {}
|
|
660
|
+
'500':
|
|
661
|
+
description: Internal Server Error - Server error
|
|
662
|
+
headers: {}
|
|
663
|
+
content: {}
|
|
664
|
+
deprecated: false
|
|
665
|
+
security:
|
|
666
|
+
- RESTToken:
|
|
667
|
+
- global
|
|
668
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment:
|
|
669
|
+
get:
|
|
670
|
+
tags:
|
|
671
|
+
- networkElements
|
|
672
|
+
summary: getNERadioEquipmentsUsingGET
|
|
673
|
+
description: 'Returns a list of specific radio equipments. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the radio equipment, as defined by the source system <br /><strong>neName:</strong> The name of the radio equipment which is unique within the source system<br /><strong>neId:</strong> The id of the radio equipment <br /><strong>description:</strong> The detailed description of the radio equipment <br /><strong>ipAddress:</strong> The management IP address of the radio equipment <br /><strong>product:</strong> The vendor product name of the radio equipment <br /><strong>version:</strong> The version of this radio equipment <br /><strong>longitude:</strong> The longitude (in degrees) of the radio equipment, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the radio equipment, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the radio equipment <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>communicationState:</strong> The communication status of the radio equipment <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the radio equipment <br /><strong>macAddress:</strong> The Mac address of the radio equipment <br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />'
|
|
674
|
+
operationId: getNERadioEquipmentsUsingGET
|
|
675
|
+
parameters:
|
|
676
|
+
- name: filter
|
|
677
|
+
in: query
|
|
678
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
679
|
+
style: form
|
|
680
|
+
explode: true
|
|
681
|
+
schema:
|
|
682
|
+
type: string
|
|
683
|
+
- name: networkElementFdn
|
|
684
|
+
in: path
|
|
685
|
+
description: networkElementFdn
|
|
686
|
+
required: true
|
|
687
|
+
style: simple
|
|
688
|
+
schema:
|
|
689
|
+
type: string
|
|
690
|
+
responses:
|
|
691
|
+
'200':
|
|
692
|
+
description: OK - Request executed successfully
|
|
693
|
+
headers: {}
|
|
694
|
+
content:
|
|
695
|
+
application/json:
|
|
696
|
+
schema:
|
|
697
|
+
type: array
|
|
698
|
+
items:
|
|
699
|
+
$ref: '#/components/schemas/RadioEquipment'
|
|
700
|
+
description: ''
|
|
701
|
+
'400':
|
|
702
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
703
|
+
headers: {}
|
|
704
|
+
content: {}
|
|
705
|
+
'401':
|
|
706
|
+
description: Unauthorized - Authentication rejected
|
|
707
|
+
headers: {}
|
|
708
|
+
content: {}
|
|
709
|
+
'403':
|
|
710
|
+
description: Forbidden - No user access to the resource
|
|
711
|
+
headers: {}
|
|
712
|
+
content: {}
|
|
713
|
+
'404':
|
|
714
|
+
description: Not Found - URL or resource does not exist
|
|
715
|
+
headers: {}
|
|
716
|
+
content: {}
|
|
717
|
+
'405':
|
|
718
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
719
|
+
headers: {}
|
|
720
|
+
content: {}
|
|
721
|
+
'422':
|
|
722
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
723
|
+
headers: {}
|
|
724
|
+
content: {}
|
|
725
|
+
'500':
|
|
726
|
+
description: Internal Server Error - Server error
|
|
727
|
+
headers: {}
|
|
728
|
+
content: {}
|
|
729
|
+
deprecated: false
|
|
730
|
+
security:
|
|
731
|
+
- RESTToken:
|
|
732
|
+
- global
|
|
733
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags:
|
|
734
|
+
get:
|
|
735
|
+
tags:
|
|
736
|
+
- networkElements
|
|
737
|
+
summary: getRadioEquipmentLagsUsingGET
|
|
738
|
+
description: 'Returns a list of specific LAGs on a radio equipment linked to a network element. The list will contain the FDN of each resulting LAG. Not providing a filter will return all LAGs.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the LAG <br /><strong>neId:</strong> The id of the LAG<br /><strong>description:</strong> The detailed description of the LAG <br /><strong>configuredAddress:</strong> The MAC Address of the LAG <br /><strong>encapType:</strong> The encapsulation type of the LAG <br /><strong>operationalSpeedUnits:</strong> The units associated to the ‘operationalSpeed’ field value for the LAG<br /><strong>operationalSpeed:</strong> The total operational speed of the LAG, in units specified by the ‘operationalSpeedUnits’ field value<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the LAG is in this state <br /><strong>objectDetails:</strong> Generic properties of the LAG <br /><br />Examples:<br />'
|
|
739
|
+
operationId: getRadioEquipmentLagsUsingGET
|
|
740
|
+
parameters:
|
|
741
|
+
- name: filter
|
|
742
|
+
in: query
|
|
743
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
744
|
+
style: form
|
|
745
|
+
explode: true
|
|
746
|
+
schema:
|
|
747
|
+
type: string
|
|
748
|
+
- name: networkElementFdn
|
|
749
|
+
in: path
|
|
750
|
+
description: networkElementFdn
|
|
751
|
+
required: true
|
|
752
|
+
style: simple
|
|
753
|
+
schema:
|
|
754
|
+
type: string
|
|
755
|
+
- name: radioEquipmentFdn
|
|
756
|
+
in: path
|
|
757
|
+
description: radioEquipmentFdn
|
|
758
|
+
required: true
|
|
759
|
+
style: simple
|
|
760
|
+
schema:
|
|
761
|
+
type: string
|
|
762
|
+
responses:
|
|
763
|
+
'200':
|
|
764
|
+
description: OK - Request executed successfully
|
|
765
|
+
headers: {}
|
|
766
|
+
content:
|
|
767
|
+
application/json:
|
|
768
|
+
schema:
|
|
769
|
+
type: array
|
|
770
|
+
items:
|
|
771
|
+
$ref: '#/components/schemas/LAG'
|
|
772
|
+
description: ''
|
|
773
|
+
'400':
|
|
774
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
775
|
+
headers: {}
|
|
776
|
+
content: {}
|
|
777
|
+
'401':
|
|
778
|
+
description: Unauthorized - Authentication rejected
|
|
779
|
+
headers: {}
|
|
780
|
+
content: {}
|
|
781
|
+
'403':
|
|
782
|
+
description: Forbidden - No user access to the resource
|
|
783
|
+
headers: {}
|
|
784
|
+
content: {}
|
|
785
|
+
'404':
|
|
786
|
+
description: Not Found - URL or resource does not exist
|
|
787
|
+
headers: {}
|
|
788
|
+
content: {}
|
|
789
|
+
'405':
|
|
790
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
791
|
+
headers: {}
|
|
792
|
+
content: {}
|
|
793
|
+
'422':
|
|
794
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
795
|
+
headers: {}
|
|
796
|
+
content: {}
|
|
797
|
+
'500':
|
|
798
|
+
description: Internal Server Error - Server error
|
|
799
|
+
headers: {}
|
|
800
|
+
content: {}
|
|
801
|
+
deprecated: false
|
|
802
|
+
security:
|
|
803
|
+
- RESTToken:
|
|
804
|
+
- global
|
|
805
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/lags/{lagFdn}/lagMembers:
|
|
806
|
+
get:
|
|
807
|
+
tags:
|
|
808
|
+
- networkElements
|
|
809
|
+
summary: getRadioEquipmentLagMembersUsingGET
|
|
810
|
+
description: Returns a list of specific LAG members a radio equipment LAG. The list will contain the FDN of each resulting LAG member. Not providing a filter will return all LAG members.<br /><br />Examples:<br />
|
|
811
|
+
operationId: getRadioEquipmentLagMembersUsingGET
|
|
812
|
+
parameters:
|
|
813
|
+
- name: filter
|
|
814
|
+
in: query
|
|
815
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
816
|
+
style: form
|
|
817
|
+
explode: true
|
|
818
|
+
schema:
|
|
819
|
+
type: string
|
|
820
|
+
- name: lagFdn
|
|
821
|
+
in: path
|
|
822
|
+
description: lagFdn
|
|
823
|
+
required: true
|
|
824
|
+
style: simple
|
|
825
|
+
schema:
|
|
826
|
+
type: string
|
|
827
|
+
- name: networkElementFdn
|
|
828
|
+
in: path
|
|
829
|
+
description: networkElementFdn
|
|
830
|
+
required: true
|
|
831
|
+
style: simple
|
|
832
|
+
schema:
|
|
833
|
+
type: string
|
|
834
|
+
- name: radioEquipmentFdn
|
|
835
|
+
in: path
|
|
836
|
+
description: radioEquipmentFdn
|
|
837
|
+
required: true
|
|
838
|
+
style: simple
|
|
839
|
+
schema:
|
|
840
|
+
type: string
|
|
841
|
+
responses:
|
|
842
|
+
'200':
|
|
843
|
+
description: OK - Request executed successfully
|
|
844
|
+
headers: {}
|
|
845
|
+
content:
|
|
846
|
+
application/json:
|
|
847
|
+
schema:
|
|
848
|
+
type: array
|
|
849
|
+
items:
|
|
850
|
+
$ref: '#/components/schemas/LAGMemberDetails'
|
|
851
|
+
description: ''
|
|
852
|
+
'400':
|
|
853
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
854
|
+
headers: {}
|
|
855
|
+
content: {}
|
|
856
|
+
'401':
|
|
857
|
+
description: Unauthorized - Authentication rejected
|
|
858
|
+
headers: {}
|
|
859
|
+
content: {}
|
|
860
|
+
'403':
|
|
861
|
+
description: Forbidden - No user access to the resource
|
|
862
|
+
headers: {}
|
|
863
|
+
content: {}
|
|
864
|
+
'404':
|
|
865
|
+
description: Not Found - URL or resource does not exist
|
|
866
|
+
headers: {}
|
|
867
|
+
content: {}
|
|
868
|
+
'405':
|
|
869
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
870
|
+
headers: {}
|
|
871
|
+
content: {}
|
|
872
|
+
'422':
|
|
873
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
874
|
+
headers: {}
|
|
875
|
+
content: {}
|
|
876
|
+
'500':
|
|
877
|
+
description: Internal Server Error - Server error
|
|
878
|
+
headers: {}
|
|
879
|
+
content: {}
|
|
880
|
+
deprecated: false
|
|
881
|
+
security:
|
|
882
|
+
- RESTToken:
|
|
883
|
+
- global
|
|
884
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves:
|
|
885
|
+
get:
|
|
886
|
+
tags:
|
|
887
|
+
- networkElements
|
|
888
|
+
summary: getRadioEquipmentShelvesUsingGET
|
|
889
|
+
description: 'Returns a list of specific shelves on a radio equipment linked to a network element. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the radio equipment containing the Shelf <br /><strong>neId:</strong> The id of the radio equipment containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the radio equipment<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />'
|
|
890
|
+
operationId: getRadioEquipmentShelvesUsingGET
|
|
891
|
+
parameters:
|
|
892
|
+
- name: filter
|
|
893
|
+
in: query
|
|
894
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
895
|
+
style: form
|
|
896
|
+
explode: true
|
|
897
|
+
schema:
|
|
898
|
+
type: string
|
|
899
|
+
- name: networkElementFdn
|
|
900
|
+
in: path
|
|
901
|
+
description: networkElementFdn
|
|
902
|
+
required: true
|
|
903
|
+
style: simple
|
|
904
|
+
schema:
|
|
905
|
+
type: string
|
|
906
|
+
- name: radioEquipmentFdn
|
|
907
|
+
in: path
|
|
908
|
+
description: radioEquipmentFdn
|
|
909
|
+
required: true
|
|
910
|
+
style: simple
|
|
911
|
+
schema:
|
|
912
|
+
type: string
|
|
913
|
+
responses:
|
|
914
|
+
'200':
|
|
915
|
+
description: OK - Request executed successfully
|
|
916
|
+
headers: {}
|
|
917
|
+
content:
|
|
918
|
+
application/json:
|
|
919
|
+
schema:
|
|
920
|
+
type: array
|
|
921
|
+
items:
|
|
922
|
+
$ref: '#/components/schemas/Shelf'
|
|
923
|
+
description: ''
|
|
924
|
+
'400':
|
|
925
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
926
|
+
headers: {}
|
|
927
|
+
content: {}
|
|
928
|
+
'401':
|
|
929
|
+
description: Unauthorized - Authentication rejected
|
|
930
|
+
headers: {}
|
|
931
|
+
content: {}
|
|
932
|
+
'403':
|
|
933
|
+
description: Forbidden - No user access to the resource
|
|
934
|
+
headers: {}
|
|
935
|
+
content: {}
|
|
936
|
+
'404':
|
|
937
|
+
description: Not Found - URL or resource does not exist
|
|
938
|
+
headers: {}
|
|
939
|
+
content: {}
|
|
940
|
+
'405':
|
|
941
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
942
|
+
headers: {}
|
|
943
|
+
content: {}
|
|
944
|
+
'422':
|
|
945
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
946
|
+
headers: {}
|
|
947
|
+
content: {}
|
|
948
|
+
'500':
|
|
949
|
+
description: Internal Server Error - Server error
|
|
950
|
+
headers: {}
|
|
951
|
+
content: {}
|
|
952
|
+
deprecated: false
|
|
953
|
+
security:
|
|
954
|
+
- RESTToken:
|
|
955
|
+
- global
|
|
956
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards:
|
|
957
|
+
get:
|
|
958
|
+
tags:
|
|
959
|
+
- networkElements
|
|
960
|
+
summary: getRadioEquipmentShelfCardsUsingGET
|
|
961
|
+
description: 'Returns a list of specific cards on a radio equipment shelf. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state <br /><strong>objectDetails:</strong> Generic properties of this Card <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card <br /><br />Examples:<br />'
|
|
962
|
+
operationId: getRadioEquipmentShelfCardsUsingGET
|
|
963
|
+
parameters:
|
|
964
|
+
- name: filter
|
|
965
|
+
in: query
|
|
966
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
967
|
+
style: form
|
|
968
|
+
explode: true
|
|
969
|
+
schema:
|
|
970
|
+
type: string
|
|
971
|
+
- name: networkElementFdn
|
|
972
|
+
in: path
|
|
973
|
+
description: networkElementFdn
|
|
974
|
+
required: true
|
|
975
|
+
style: simple
|
|
976
|
+
schema:
|
|
977
|
+
type: string
|
|
978
|
+
- name: radioEquipmentFdn
|
|
979
|
+
in: path
|
|
980
|
+
description: radioEquipmentFdn
|
|
981
|
+
required: true
|
|
982
|
+
style: simple
|
|
983
|
+
schema:
|
|
984
|
+
type: string
|
|
985
|
+
- name: shelfFdn
|
|
986
|
+
in: path
|
|
987
|
+
description: shelfFdn
|
|
988
|
+
required: true
|
|
989
|
+
style: simple
|
|
990
|
+
schema:
|
|
991
|
+
type: string
|
|
992
|
+
responses:
|
|
993
|
+
'200':
|
|
994
|
+
description: OK - Request executed successfully
|
|
995
|
+
headers: {}
|
|
996
|
+
content:
|
|
997
|
+
application/json:
|
|
998
|
+
schema:
|
|
999
|
+
type: array
|
|
1000
|
+
items:
|
|
1001
|
+
$ref: '#/components/schemas/Card'
|
|
1002
|
+
description: ''
|
|
1003
|
+
'400':
|
|
1004
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1005
|
+
headers: {}
|
|
1006
|
+
content: {}
|
|
1007
|
+
'401':
|
|
1008
|
+
description: Unauthorized - Authentication rejected
|
|
1009
|
+
headers: {}
|
|
1010
|
+
content: {}
|
|
1011
|
+
'403':
|
|
1012
|
+
description: Forbidden - No user access to the resource
|
|
1013
|
+
headers: {}
|
|
1014
|
+
content: {}
|
|
1015
|
+
'404':
|
|
1016
|
+
description: Not Found - URL or resource does not exist
|
|
1017
|
+
headers: {}
|
|
1018
|
+
content: {}
|
|
1019
|
+
'405':
|
|
1020
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1021
|
+
headers: {}
|
|
1022
|
+
content: {}
|
|
1023
|
+
'422':
|
|
1024
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1025
|
+
headers: {}
|
|
1026
|
+
content: {}
|
|
1027
|
+
'500':
|
|
1028
|
+
description: Internal Server Error - Server error
|
|
1029
|
+
headers: {}
|
|
1030
|
+
content: {}
|
|
1031
|
+
deprecated: false
|
|
1032
|
+
security:
|
|
1033
|
+
- RESTToken:
|
|
1034
|
+
- global
|
|
1035
|
+
/v1/networkElements/{networkElementFdn}/radioEquipment/{radioEquipmentFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports:
|
|
1036
|
+
get:
|
|
1037
|
+
tags:
|
|
1038
|
+
- networkElements
|
|
1039
|
+
summary: getRadioEquipmentCardPortsUsingGET
|
|
1040
|
+
description: 'Returns a list of specific ports on a radio equipment card. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Port <br /><strong>neId:</strong> The id of the Network Element containing the Port <br /><strong>description:</strong> The detailed description of the Port <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state <br /><strong>objectDetails:</strong> Generic properties of this Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />'
|
|
1041
|
+
operationId: getRadioEquipmentCardPortsUsingGET
|
|
1042
|
+
parameters:
|
|
1043
|
+
- name: cardFdn
|
|
1044
|
+
in: path
|
|
1045
|
+
description: cardFdn
|
|
1046
|
+
required: true
|
|
1047
|
+
style: simple
|
|
1048
|
+
schema:
|
|
1049
|
+
type: string
|
|
1050
|
+
- name: filter
|
|
1051
|
+
in: query
|
|
1052
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1053
|
+
style: form
|
|
1054
|
+
explode: true
|
|
1055
|
+
schema:
|
|
1056
|
+
type: string
|
|
1057
|
+
- name: networkElementFdn
|
|
1058
|
+
in: path
|
|
1059
|
+
description: networkElementFdn
|
|
1060
|
+
required: true
|
|
1061
|
+
style: simple
|
|
1062
|
+
schema:
|
|
1063
|
+
type: string
|
|
1064
|
+
- name: radioEquipmentFdn
|
|
1065
|
+
in: path
|
|
1066
|
+
description: radioEquipmentFdn
|
|
1067
|
+
required: true
|
|
1068
|
+
style: simple
|
|
1069
|
+
schema:
|
|
1070
|
+
type: string
|
|
1071
|
+
- name: shelfFdn
|
|
1072
|
+
in: path
|
|
1073
|
+
description: shelfFdn
|
|
1074
|
+
required: true
|
|
1075
|
+
style: simple
|
|
1076
|
+
schema:
|
|
1077
|
+
type: string
|
|
1078
|
+
responses:
|
|
1079
|
+
'200':
|
|
1080
|
+
description: OK - Request executed successfully
|
|
1081
|
+
headers: {}
|
|
1082
|
+
content:
|
|
1083
|
+
application/json:
|
|
1084
|
+
schema:
|
|
1085
|
+
type: array
|
|
1086
|
+
items:
|
|
1087
|
+
$ref: '#/components/schemas/Port'
|
|
1088
|
+
description: ''
|
|
1089
|
+
'400':
|
|
1090
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1091
|
+
headers: {}
|
|
1092
|
+
content: {}
|
|
1093
|
+
'401':
|
|
1094
|
+
description: Unauthorized - Authentication rejected
|
|
1095
|
+
headers: {}
|
|
1096
|
+
content: {}
|
|
1097
|
+
'403':
|
|
1098
|
+
description: Forbidden - No user access to the resource
|
|
1099
|
+
headers: {}
|
|
1100
|
+
content: {}
|
|
1101
|
+
'404':
|
|
1102
|
+
description: Not Found - URL or resource does not exist
|
|
1103
|
+
headers: {}
|
|
1104
|
+
content: {}
|
|
1105
|
+
'405':
|
|
1106
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1107
|
+
headers: {}
|
|
1108
|
+
content: {}
|
|
1109
|
+
'422':
|
|
1110
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1111
|
+
headers: {}
|
|
1112
|
+
content: {}
|
|
1113
|
+
'500':
|
|
1114
|
+
description: Internal Server Error - Server error
|
|
1115
|
+
headers: {}
|
|
1116
|
+
content: {}
|
|
1117
|
+
deprecated: false
|
|
1118
|
+
security:
|
|
1119
|
+
- RESTToken:
|
|
1120
|
+
- global
|
|
1121
|
+
/v1/networkElements/{networkElementFdn}/shelves:
|
|
1122
|
+
get:
|
|
1123
|
+
tags:
|
|
1124
|
+
- networkElements
|
|
1125
|
+
summary: getNEShelvesUsingGET
|
|
1126
|
+
description: 'Returns a list of specific shelves. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Shelf <br /><strong>neId:</strong> The id of the Network Element containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />'
|
|
1127
|
+
operationId: getNEShelvesUsingGET
|
|
1128
|
+
parameters:
|
|
1129
|
+
- name: filter
|
|
1130
|
+
in: query
|
|
1131
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1132
|
+
style: form
|
|
1133
|
+
explode: true
|
|
1134
|
+
schema:
|
|
1135
|
+
type: string
|
|
1136
|
+
- name: networkElementFdn
|
|
1137
|
+
in: path
|
|
1138
|
+
description: networkElementFdn
|
|
1139
|
+
required: true
|
|
1140
|
+
style: simple
|
|
1141
|
+
schema:
|
|
1142
|
+
type: string
|
|
1143
|
+
responses:
|
|
1144
|
+
'200':
|
|
1145
|
+
description: OK - Request executed successfully
|
|
1146
|
+
headers: {}
|
|
1147
|
+
content:
|
|
1148
|
+
application/json:
|
|
1149
|
+
schema:
|
|
1150
|
+
type: array
|
|
1151
|
+
items:
|
|
1152
|
+
$ref: '#/components/schemas/Shelf'
|
|
1153
|
+
description: ''
|
|
1154
|
+
'400':
|
|
1155
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1156
|
+
headers: {}
|
|
1157
|
+
content: {}
|
|
1158
|
+
'401':
|
|
1159
|
+
description: Unauthorized - Authentication rejected
|
|
1160
|
+
headers: {}
|
|
1161
|
+
content: {}
|
|
1162
|
+
'403':
|
|
1163
|
+
description: Forbidden - No user access to the resource
|
|
1164
|
+
headers: {}
|
|
1165
|
+
content: {}
|
|
1166
|
+
'404':
|
|
1167
|
+
description: Not Found - URL or resource does not exist
|
|
1168
|
+
headers: {}
|
|
1169
|
+
content: {}
|
|
1170
|
+
'405':
|
|
1171
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1172
|
+
headers: {}
|
|
1173
|
+
content: {}
|
|
1174
|
+
'422':
|
|
1175
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1176
|
+
headers: {}
|
|
1177
|
+
content: {}
|
|
1178
|
+
'500':
|
|
1179
|
+
description: Internal Server Error - Server error
|
|
1180
|
+
headers: {}
|
|
1181
|
+
content: {}
|
|
1182
|
+
deprecated: false
|
|
1183
|
+
security:
|
|
1184
|
+
- RESTToken:
|
|
1185
|
+
- global
|
|
1186
|
+
/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards:
|
|
1187
|
+
get:
|
|
1188
|
+
tags:
|
|
1189
|
+
- networkElements
|
|
1190
|
+
summary: getShelfCardsUsingGET
|
|
1191
|
+
description: 'Returns a list of specific cards. The list will contain the FDN of each resulting card. Not providing a filter will return all cards.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Card <br /><strong>neId:</strong> The id of the Network Element containing the Card <br /><strong>description:</strong> The detailed description of the Card <br /><strong>positionId:</strong> The relative position of the Card that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Card within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Card is in this state <br /><strong>objectDetails:</strong> Generic properties of the Card <br /><strong>manufacturer:</strong> The vendor of the Card <br /><strong>serialNumber:</strong> The serial number of the Card provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Card provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Card provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Card <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Card provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Card <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Card <br /><br />Examples:<br />'
|
|
1192
|
+
operationId: getShelfCardsUsingGET
|
|
1193
|
+
parameters:
|
|
1194
|
+
- name: filter
|
|
1195
|
+
in: query
|
|
1196
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1197
|
+
style: form
|
|
1198
|
+
explode: true
|
|
1199
|
+
schema:
|
|
1200
|
+
type: string
|
|
1201
|
+
- name: networkElementFdn
|
|
1202
|
+
in: path
|
|
1203
|
+
description: networkElementFdn
|
|
1204
|
+
required: true
|
|
1205
|
+
style: simple
|
|
1206
|
+
schema:
|
|
1207
|
+
type: string
|
|
1208
|
+
- name: shelfFdn
|
|
1209
|
+
in: path
|
|
1210
|
+
description: shelfFdn
|
|
1211
|
+
required: true
|
|
1212
|
+
style: simple
|
|
1213
|
+
schema:
|
|
1214
|
+
type: string
|
|
1215
|
+
responses:
|
|
1216
|
+
'200':
|
|
1217
|
+
description: OK - Request executed successfully
|
|
1218
|
+
headers: {}
|
|
1219
|
+
content:
|
|
1220
|
+
application/json:
|
|
1221
|
+
schema:
|
|
1222
|
+
type: array
|
|
1223
|
+
items:
|
|
1224
|
+
$ref: '#/components/schemas/Card'
|
|
1225
|
+
description: ''
|
|
1226
|
+
'400':
|
|
1227
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1228
|
+
headers: {}
|
|
1229
|
+
content: {}
|
|
1230
|
+
'401':
|
|
1231
|
+
description: Unauthorized - Authentication rejected
|
|
1232
|
+
headers: {}
|
|
1233
|
+
content: {}
|
|
1234
|
+
'403':
|
|
1235
|
+
description: Forbidden - No user access to the resource
|
|
1236
|
+
headers: {}
|
|
1237
|
+
content: {}
|
|
1238
|
+
'404':
|
|
1239
|
+
description: Not Found - URL or resource does not exist
|
|
1240
|
+
headers: {}
|
|
1241
|
+
content: {}
|
|
1242
|
+
'405':
|
|
1243
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1244
|
+
headers: {}
|
|
1245
|
+
content: {}
|
|
1246
|
+
'422':
|
|
1247
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1248
|
+
headers: {}
|
|
1249
|
+
content: {}
|
|
1250
|
+
'500':
|
|
1251
|
+
description: Internal Server Error - Server error
|
|
1252
|
+
headers: {}
|
|
1253
|
+
content: {}
|
|
1254
|
+
deprecated: false
|
|
1255
|
+
security:
|
|
1256
|
+
- RESTToken:
|
|
1257
|
+
- global
|
|
1258
|
+
/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/cards/{cardFdn}/ports:
|
|
1259
|
+
get:
|
|
1260
|
+
tags:
|
|
1261
|
+
- networkElements
|
|
1262
|
+
summary: getCardPortsUsingGET
|
|
1263
|
+
description: Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br />Examples:<br />
|
|
1264
|
+
operationId: getCardPortsUsingGET
|
|
1265
|
+
parameters:
|
|
1266
|
+
- name: cardFdn
|
|
1267
|
+
in: path
|
|
1268
|
+
description: cardFdn
|
|
1269
|
+
required: true
|
|
1270
|
+
style: simple
|
|
1271
|
+
schema:
|
|
1272
|
+
type: string
|
|
1273
|
+
- name: filter
|
|
1274
|
+
in: query
|
|
1275
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1276
|
+
style: form
|
|
1277
|
+
explode: true
|
|
1278
|
+
schema:
|
|
1279
|
+
type: string
|
|
1280
|
+
- name: networkElementFdn
|
|
1281
|
+
in: path
|
|
1282
|
+
description: networkElementFdn
|
|
1283
|
+
required: true
|
|
1284
|
+
style: simple
|
|
1285
|
+
schema:
|
|
1286
|
+
type: string
|
|
1287
|
+
- name: shelfFdn
|
|
1288
|
+
in: path
|
|
1289
|
+
description: shelfFdn
|
|
1290
|
+
required: true
|
|
1291
|
+
style: simple
|
|
1292
|
+
schema:
|
|
1293
|
+
type: string
|
|
1294
|
+
responses:
|
|
1295
|
+
'200':
|
|
1296
|
+
description: OK - Request executed successfully
|
|
1297
|
+
headers: {}
|
|
1298
|
+
content:
|
|
1299
|
+
application/json:
|
|
1300
|
+
schema:
|
|
1301
|
+
type: array
|
|
1302
|
+
items:
|
|
1303
|
+
$ref: '#/components/schemas/Port'
|
|
1304
|
+
description: ''
|
|
1305
|
+
'400':
|
|
1306
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1307
|
+
headers: {}
|
|
1308
|
+
content: {}
|
|
1309
|
+
'401':
|
|
1310
|
+
description: Unauthorized - Authentication rejected
|
|
1311
|
+
headers: {}
|
|
1312
|
+
content: {}
|
|
1313
|
+
'403':
|
|
1314
|
+
description: Forbidden - No user access to the resource
|
|
1315
|
+
headers: {}
|
|
1316
|
+
content: {}
|
|
1317
|
+
'404':
|
|
1318
|
+
description: Not Found - URL or resource does not exist
|
|
1319
|
+
headers: {}
|
|
1320
|
+
content: {}
|
|
1321
|
+
'405':
|
|
1322
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1323
|
+
headers: {}
|
|
1324
|
+
content: {}
|
|
1325
|
+
'422':
|
|
1326
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1327
|
+
headers: {}
|
|
1328
|
+
content: {}
|
|
1329
|
+
'500':
|
|
1330
|
+
description: Internal Server Error - Server error
|
|
1331
|
+
headers: {}
|
|
1332
|
+
content: {}
|
|
1333
|
+
deprecated: false
|
|
1334
|
+
security:
|
|
1335
|
+
- RESTToken:
|
|
1336
|
+
- global
|
|
1337
|
+
/v1/networkElements/{networkElementFdn}/shelves/{shelfFdn}/ports:
|
|
1338
|
+
get:
|
|
1339
|
+
tags:
|
|
1340
|
+
- networkElements
|
|
1341
|
+
summary: getShelfPortsUsingGET
|
|
1342
|
+
description: 'Returns a list of specific ports. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing this Port <br /><strong>neId:</strong> The id of the Network Element containing this Port <br /><strong>description:</strong> The detailed description of the Port <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Shelf<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state <br /><strong>objectDetails:</strong> Generic properties of the Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />'
|
|
1343
|
+
operationId: getShelfPortsUsingGET
|
|
1344
|
+
parameters:
|
|
1345
|
+
- name: filter
|
|
1346
|
+
in: query
|
|
1347
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1348
|
+
style: form
|
|
1349
|
+
explode: true
|
|
1350
|
+
schema:
|
|
1351
|
+
type: string
|
|
1352
|
+
- name: networkElementFdn
|
|
1353
|
+
in: path
|
|
1354
|
+
description: networkElementFdn
|
|
1355
|
+
required: true
|
|
1356
|
+
style: simple
|
|
1357
|
+
schema:
|
|
1358
|
+
type: string
|
|
1359
|
+
- name: shelfFdn
|
|
1360
|
+
in: path
|
|
1361
|
+
description: shelfFdn
|
|
1362
|
+
required: true
|
|
1363
|
+
style: simple
|
|
1364
|
+
schema:
|
|
1365
|
+
type: string
|
|
1366
|
+
responses:
|
|
1367
|
+
'200':
|
|
1368
|
+
description: OK - Request executed successfully
|
|
1369
|
+
headers: {}
|
|
1370
|
+
content:
|
|
1371
|
+
application/json:
|
|
1372
|
+
schema:
|
|
1373
|
+
type: array
|
|
1374
|
+
items:
|
|
1375
|
+
$ref: '#/components/schemas/Port'
|
|
1376
|
+
description: ''
|
|
1377
|
+
'400':
|
|
1378
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1379
|
+
headers: {}
|
|
1380
|
+
content: {}
|
|
1381
|
+
'401':
|
|
1382
|
+
description: Unauthorized - Authentication rejected
|
|
1383
|
+
headers: {}
|
|
1384
|
+
content: {}
|
|
1385
|
+
'403':
|
|
1386
|
+
description: Forbidden - No user access to the resource
|
|
1387
|
+
headers: {}
|
|
1388
|
+
content: {}
|
|
1389
|
+
'404':
|
|
1390
|
+
description: Not Found - URL or resource does not exist
|
|
1391
|
+
headers: {}
|
|
1392
|
+
content: {}
|
|
1393
|
+
'405':
|
|
1394
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1395
|
+
headers: {}
|
|
1396
|
+
content: {}
|
|
1397
|
+
'422':
|
|
1398
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1399
|
+
headers: {}
|
|
1400
|
+
content: {}
|
|
1401
|
+
'500':
|
|
1402
|
+
description: Internal Server Error - Server error
|
|
1403
|
+
headers: {}
|
|
1404
|
+
content: {}
|
|
1405
|
+
deprecated: false
|
|
1406
|
+
security:
|
|
1407
|
+
- RESTToken:
|
|
1408
|
+
- global
|
|
1409
|
+
/v1/physicalLinks:
|
|
1410
|
+
get:
|
|
1411
|
+
tags:
|
|
1412
|
+
- physicalLinks
|
|
1413
|
+
summary: getPhysicalLinksUsingGET
|
|
1414
|
+
description: "Returns a paged list of specific physical links. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting physical link. Not providing a filter will return all physical links.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>id:</strong> The short identifier of the Physical Link <br /><strong>type:</strong> The type of the Physical Link <br /><strong>rate:</strong> The rate label of the Physical Link <br /><strong>actualRate:</strong> The rate of the Physical Link, in units specified by the ‘actualRateUnits’ field value <br /><strong>actualRateUnits:</strong> The units associated to the ‘actualRate’ field value for the Physical Link <br /><strong>description:</strong> The detailed description of this Physical Link <br /><strong>protection:</strong> Indicates if the Physical Link is protected or unprotected <br /><strong>protectionKind:</strong> The type of protection for the Physical Link <br /><strong>latency:</strong> The latency of the Physical Link, if known, in units specified by the ‘latencyUnits’ field value <br /><strong>latencyUnits:</strong> The units associated to the ‘latency’ field value for the Physical Link <br /><strong>restoration:</strong> The restoration type for the Physical Link <br /><strong>direction:</strong> The direction of the Physical Link <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the Physical Link <br /><br />Examples:<br />Get all physical links: GET /v1/physicalLinks<br />Get all physical links, using a comma-separated list of FDNs: GET /v1/physicalLinks?fdns=fdn:model:service:Service:2410,fdn:model:service:Service:2411<br />Get all physical links, with filter by direction: GET /v1/physicalLinks?filter=direction%3D'biDirectional'<br />Get all physical links, with filter by latency: GET /v1/physicalLinks?filter=NOT%20(latency%3D0)<br />Get all physical links, with filter by combined criteria: GET /v1/physicalLinks?filter=direction%3D'biDirectional'%20AND%20NOT%20(latency%3D0)<br />Get all physical links, including NE data: GET /v1/physicalLinks?neFetch=true"
|
|
1415
|
+
operationId: getPhysicalLinksUsingGET
|
|
1416
|
+
parameters:
|
|
1417
|
+
- name: fdns
|
|
1418
|
+
in: query
|
|
1419
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
1420
|
+
style: form
|
|
1421
|
+
explode: true
|
|
1422
|
+
schema:
|
|
1423
|
+
type: string
|
|
1424
|
+
- name: filter
|
|
1425
|
+
in: query
|
|
1426
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1427
|
+
style: form
|
|
1428
|
+
explode: true
|
|
1429
|
+
schema:
|
|
1430
|
+
type: string
|
|
1431
|
+
- name: limit
|
|
1432
|
+
in: query
|
|
1433
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
1434
|
+
style: form
|
|
1435
|
+
explode: true
|
|
1436
|
+
schema:
|
|
1437
|
+
type: integer
|
|
1438
|
+
format: int32
|
|
1439
|
+
default: 300
|
|
1440
|
+
- name: neFetch
|
|
1441
|
+
in: query
|
|
1442
|
+
description: A boolean value to determine whether to fetch NE data
|
|
1443
|
+
style: form
|
|
1444
|
+
explode: true
|
|
1445
|
+
schema:
|
|
1446
|
+
type: boolean
|
|
1447
|
+
default: false
|
|
1448
|
+
- name: offset
|
|
1449
|
+
in: query
|
|
1450
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
1451
|
+
style: form
|
|
1452
|
+
explode: true
|
|
1453
|
+
schema:
|
|
1454
|
+
type: integer
|
|
1455
|
+
format: int32
|
|
1456
|
+
default: 0
|
|
1457
|
+
responses:
|
|
1458
|
+
'200':
|
|
1459
|
+
description: OK - Request executed successfully
|
|
1460
|
+
headers: {}
|
|
1461
|
+
content:
|
|
1462
|
+
application/json:
|
|
1463
|
+
schema:
|
|
1464
|
+
type: array
|
|
1465
|
+
items:
|
|
1466
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
1467
|
+
description: ''
|
|
1468
|
+
'400':
|
|
1469
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1470
|
+
headers: {}
|
|
1471
|
+
content: {}
|
|
1472
|
+
'401':
|
|
1473
|
+
description: Unauthorized - Authentication rejected
|
|
1474
|
+
headers: {}
|
|
1475
|
+
content: {}
|
|
1476
|
+
'404':
|
|
1477
|
+
description: Not Found - URL or resource does not exist
|
|
1478
|
+
headers: {}
|
|
1479
|
+
content: {}
|
|
1480
|
+
'405':
|
|
1481
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1482
|
+
headers: {}
|
|
1483
|
+
content: {}
|
|
1484
|
+
'500':
|
|
1485
|
+
description: Internal Server Error - Server error
|
|
1486
|
+
headers: {}
|
|
1487
|
+
content: {}
|
|
1488
|
+
deprecated: false
|
|
1489
|
+
security:
|
|
1490
|
+
- RESTToken:
|
|
1491
|
+
- global
|
|
1492
|
+
post:
|
|
1493
|
+
tags:
|
|
1494
|
+
- physicalLinks
|
|
1495
|
+
summary: createPhysicalLinkUsingPOST
|
|
1496
|
+
description: This API allows admin users to create a 'cable' physical link manually. Endpoints can either be physicalPort to physicalPort or networkElement to networkElement or LAG to LAG.
|
|
1497
|
+
operationId: createPhysicalLinkUsingPOST
|
|
1498
|
+
parameters: []
|
|
1499
|
+
requestBody:
|
|
1500
|
+
description: physicalLink
|
|
1501
|
+
content:
|
|
1502
|
+
application/json:
|
|
1503
|
+
schema:
|
|
1504
|
+
allOf:
|
|
1505
|
+
- $ref: '#/components/schemas/PhysicalLink'
|
|
1506
|
+
- description: physicalLink
|
|
1507
|
+
required: true
|
|
1508
|
+
responses:
|
|
1509
|
+
'200':
|
|
1510
|
+
description: OK
|
|
1511
|
+
headers: {}
|
|
1512
|
+
content:
|
|
1513
|
+
application/json:
|
|
1514
|
+
schema:
|
|
1515
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
1516
|
+
'201':
|
|
1517
|
+
description: Created - Request executed successfully
|
|
1518
|
+
headers: {}
|
|
1519
|
+
content:
|
|
1520
|
+
application/json:
|
|
1521
|
+
schema:
|
|
1522
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
1523
|
+
'400':
|
|
1524
|
+
description: Bad Request - Malformed content or invalid parameter data provided or operation failure
|
|
1525
|
+
headers: {}
|
|
1526
|
+
content: {}
|
|
1527
|
+
'401':
|
|
1528
|
+
description: Unauthorized - Authentication rejected
|
|
1529
|
+
headers: {}
|
|
1530
|
+
content: {}
|
|
1531
|
+
'403':
|
|
1532
|
+
description: Forbidden - No user access to the resource
|
|
1533
|
+
headers: {}
|
|
1534
|
+
content: {}
|
|
1535
|
+
'404':
|
|
1536
|
+
description: Not Found - URL or resource does not exist
|
|
1537
|
+
headers: {}
|
|
1538
|
+
content: {}
|
|
1539
|
+
'405':
|
|
1540
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1541
|
+
headers: {}
|
|
1542
|
+
content: {}
|
|
1543
|
+
'500':
|
|
1544
|
+
description: Internal Server Error - Server error
|
|
1545
|
+
headers: {}
|
|
1546
|
+
content: {}
|
|
1547
|
+
deprecated: false
|
|
1548
|
+
security:
|
|
1549
|
+
- RESTToken:
|
|
1550
|
+
- global
|
|
1551
|
+
/v1/physicalLinks/{physicalLinkFdn}:
|
|
1552
|
+
get:
|
|
1553
|
+
tags:
|
|
1554
|
+
- physicalLinks
|
|
1555
|
+
summary: getPhysicalLinkUsingGET
|
|
1556
|
+
description: Returns detailed information for the specified physical link.<br /><br />Example:<br />GET /v1/physicalLinks/fdn:model:service:Service:2410
|
|
1557
|
+
operationId: getPhysicalLinkUsingGET
|
|
1558
|
+
parameters:
|
|
1559
|
+
- name: physicalLinkFdn
|
|
1560
|
+
in: path
|
|
1561
|
+
description: physicalLinkFdn
|
|
1562
|
+
required: true
|
|
1563
|
+
style: simple
|
|
1564
|
+
schema:
|
|
1565
|
+
type: string
|
|
1566
|
+
responses:
|
|
1567
|
+
'200':
|
|
1568
|
+
description: OK - Request executed successfully
|
|
1569
|
+
headers: {}
|
|
1570
|
+
content:
|
|
1571
|
+
application/json:
|
|
1572
|
+
schema:
|
|
1573
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
1574
|
+
'400':
|
|
1575
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1576
|
+
headers: {}
|
|
1577
|
+
content: {}
|
|
1578
|
+
'401':
|
|
1579
|
+
description: Unauthorized - Authentication rejected
|
|
1580
|
+
headers: {}
|
|
1581
|
+
content: {}
|
|
1582
|
+
'404':
|
|
1583
|
+
description: Not Found - URL or resource does not exist
|
|
1584
|
+
headers: {}
|
|
1585
|
+
content: {}
|
|
1586
|
+
'405':
|
|
1587
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1588
|
+
headers: {}
|
|
1589
|
+
content: {}
|
|
1590
|
+
'422':
|
|
1591
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1592
|
+
headers: {}
|
|
1593
|
+
content: {}
|
|
1594
|
+
'500':
|
|
1595
|
+
description: Internal Server Error - Server error
|
|
1596
|
+
headers: {}
|
|
1597
|
+
content: {}
|
|
1598
|
+
deprecated: false
|
|
1599
|
+
security:
|
|
1600
|
+
- RESTToken:
|
|
1601
|
+
- global
|
|
1602
|
+
delete:
|
|
1603
|
+
tags:
|
|
1604
|
+
- physicalLinks
|
|
1605
|
+
summary: deletePhysicalLinkUsingDELETE
|
|
1606
|
+
description: This API allows admin users to delete a manually created physical link.
|
|
1607
|
+
operationId: deletePhysicalLinkUsingDELETE
|
|
1608
|
+
parameters:
|
|
1609
|
+
- name: physicalLinkFdn
|
|
1610
|
+
in: path
|
|
1611
|
+
description: physicalLinkFdn
|
|
1612
|
+
required: true
|
|
1613
|
+
style: simple
|
|
1614
|
+
schema:
|
|
1615
|
+
type: string
|
|
1616
|
+
responses:
|
|
1617
|
+
'200':
|
|
1618
|
+
description: Deleted - Request executed successfully
|
|
1619
|
+
headers: {}
|
|
1620
|
+
content:
|
|
1621
|
+
application/json:
|
|
1622
|
+
schema:
|
|
1623
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
1624
|
+
'400':
|
|
1625
|
+
description: Bad Request - Malformed content or invalid parameter data provided or operation failure
|
|
1626
|
+
headers: {}
|
|
1627
|
+
content: {}
|
|
1628
|
+
'401':
|
|
1629
|
+
description: Unauthorized - Authentication rejected
|
|
1630
|
+
headers: {}
|
|
1631
|
+
content: {}
|
|
1632
|
+
'403':
|
|
1633
|
+
description: Forbidden - No user access to the resource
|
|
1634
|
+
headers: {}
|
|
1635
|
+
content: {}
|
|
1636
|
+
'404':
|
|
1637
|
+
description: Not Found - URL or resource does not exist
|
|
1638
|
+
headers: {}
|
|
1639
|
+
content: {}
|
|
1640
|
+
'405':
|
|
1641
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1642
|
+
headers: {}
|
|
1643
|
+
content: {}
|
|
1644
|
+
'500':
|
|
1645
|
+
description: Internal Server Error - Server error
|
|
1646
|
+
headers: {}
|
|
1647
|
+
content: {}
|
|
1648
|
+
deprecated: false
|
|
1649
|
+
security:
|
|
1650
|
+
- RESTToken:
|
|
1651
|
+
- global
|
|
1652
|
+
/v1/ports:
|
|
1653
|
+
get:
|
|
1654
|
+
tags:
|
|
1655
|
+
- ports
|
|
1656
|
+
summary: getPortsUsingGET
|
|
1657
|
+
description: "Returns a paged list of specific ports. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting port. Not providing a filter will return all ports.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing this Port <br /><strong>neId:</strong> The id of the Network Element containing the Port <br /><strong>description:</strong> The detailed description of the Port <br /><strong>positionId:</strong> The relative position of the Port that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Port within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Port is in this state <br /><strong>objectDetails:</strong> Generic properties of the Port <br /><strong>manufacturer:</strong> The vendor of the Port <br /><strong>serialNumber:</strong> The serial number of the Port provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Port provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Port provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Port <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Port provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Port <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Port <br /><br />Examples:<br />Get all ports: GET /v1/ports<br />Get all ports, using a comma-separated list of FDNs: GET /v1/ports?fdns=fdn:model:equipment:Equipment:2189,fdn:model:equipment:Equipment:2190<br />Get all ports, with filter by name: GET /v1/ports?filter=name%20LIKE%20'%25%2F3'<br />Get all ports, with filter by standbyState: GET /v1/ports?filter=standbyState%3D'providingService'<br />Get all ports, with filter by combined criteria: GET /v1/ports?filter=NOT%20(name%20LIKE%20'%25%2F3')%20AND%20standbyState%3D'providingService'"
|
|
1658
|
+
operationId: getPortsUsingGET
|
|
1659
|
+
parameters:
|
|
1660
|
+
- name: fdns
|
|
1661
|
+
in: query
|
|
1662
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
1663
|
+
style: form
|
|
1664
|
+
explode: true
|
|
1665
|
+
schema:
|
|
1666
|
+
type: string
|
|
1667
|
+
- name: filter
|
|
1668
|
+
in: query
|
|
1669
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1670
|
+
style: form
|
|
1671
|
+
explode: true
|
|
1672
|
+
schema:
|
|
1673
|
+
type: string
|
|
1674
|
+
- name: limit
|
|
1675
|
+
in: query
|
|
1676
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
1677
|
+
style: form
|
|
1678
|
+
explode: true
|
|
1679
|
+
schema:
|
|
1680
|
+
type: integer
|
|
1681
|
+
format: int32
|
|
1682
|
+
default: 300
|
|
1683
|
+
- name: offset
|
|
1684
|
+
in: query
|
|
1685
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
1686
|
+
style: form
|
|
1687
|
+
explode: true
|
|
1688
|
+
schema:
|
|
1689
|
+
type: integer
|
|
1690
|
+
format: int32
|
|
1691
|
+
default: 0
|
|
1692
|
+
responses:
|
|
1693
|
+
'200':
|
|
1694
|
+
description: OK - Request executed successfully
|
|
1695
|
+
headers: {}
|
|
1696
|
+
content:
|
|
1697
|
+
application/json:
|
|
1698
|
+
schema:
|
|
1699
|
+
type: array
|
|
1700
|
+
items:
|
|
1701
|
+
$ref: '#/components/schemas/Port'
|
|
1702
|
+
description: ''
|
|
1703
|
+
'400':
|
|
1704
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1705
|
+
headers: {}
|
|
1706
|
+
content: {}
|
|
1707
|
+
'401':
|
|
1708
|
+
description: Unauthorized - Authentication rejected
|
|
1709
|
+
headers: {}
|
|
1710
|
+
content: {}
|
|
1711
|
+
'404':
|
|
1712
|
+
description: Not Found - URL or resource does not exist
|
|
1713
|
+
headers: {}
|
|
1714
|
+
content: {}
|
|
1715
|
+
'405':
|
|
1716
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1717
|
+
headers: {}
|
|
1718
|
+
content: {}
|
|
1719
|
+
'500':
|
|
1720
|
+
description: Internal Server Error - Server error
|
|
1721
|
+
headers: {}
|
|
1722
|
+
content: {}
|
|
1723
|
+
deprecated: false
|
|
1724
|
+
security:
|
|
1725
|
+
- RESTToken:
|
|
1726
|
+
- global
|
|
1727
|
+
/v1/ports/{portFdn}:
|
|
1728
|
+
get:
|
|
1729
|
+
tags:
|
|
1730
|
+
- ports
|
|
1731
|
+
summary: getPortUsingGET
|
|
1732
|
+
description: Returns detailed information for the specified port.<br /><br />Example:<br />GET /v1/ports/equipment:Equipment:2189
|
|
1733
|
+
operationId: getPortUsingGET
|
|
1734
|
+
parameters:
|
|
1735
|
+
- name: portFdn
|
|
1736
|
+
in: path
|
|
1737
|
+
description: portFdn
|
|
1738
|
+
required: true
|
|
1739
|
+
style: simple
|
|
1740
|
+
schema:
|
|
1741
|
+
type: string
|
|
1742
|
+
responses:
|
|
1743
|
+
'200':
|
|
1744
|
+
description: OK - Request executed successfully
|
|
1745
|
+
headers: {}
|
|
1746
|
+
content:
|
|
1747
|
+
application/json:
|
|
1748
|
+
schema:
|
|
1749
|
+
$ref: '#/components/schemas/Port'
|
|
1750
|
+
'400':
|
|
1751
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1752
|
+
headers: {}
|
|
1753
|
+
content: {}
|
|
1754
|
+
'401':
|
|
1755
|
+
description: Unauthorized - Authentication rejected
|
|
1756
|
+
headers: {}
|
|
1757
|
+
content: {}
|
|
1758
|
+
'403':
|
|
1759
|
+
description: Forbidden - No user access to the resource
|
|
1760
|
+
headers: {}
|
|
1761
|
+
content: {}
|
|
1762
|
+
'404':
|
|
1763
|
+
description: Not Found - URL or resource does not exist
|
|
1764
|
+
headers: {}
|
|
1765
|
+
content: {}
|
|
1766
|
+
'405':
|
|
1767
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1768
|
+
headers: {}
|
|
1769
|
+
content: {}
|
|
1770
|
+
'422':
|
|
1771
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1772
|
+
headers: {}
|
|
1773
|
+
content: {}
|
|
1774
|
+
'500':
|
|
1775
|
+
description: Internal Server Error - Server error
|
|
1776
|
+
headers: {}
|
|
1777
|
+
content: {}
|
|
1778
|
+
deprecated: false
|
|
1779
|
+
security:
|
|
1780
|
+
- RESTToken:
|
|
1781
|
+
- global
|
|
1782
|
+
/v1/radioEquipment:
|
|
1783
|
+
get:
|
|
1784
|
+
tags:
|
|
1785
|
+
- radioEquipment
|
|
1786
|
+
summary: getRadioEquipmentsUsingGET
|
|
1787
|
+
description: "Returns a paged list of specific radio equipments. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting Radio Equipment. Not providing a filter will return all Radio Equipments.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The name of the radio equipment, as defined by the source system <br /><strong>neName:</strong> The name of the radio equipment which is unique within the source system<br /><strong>neId:</strong> The id of the radio equipment <br /><strong>description:</strong> The detailed description of the radio equipment <br /><strong>ipAddress:</strong> The management IP address of the radio equipment <br /><strong>product:</strong> The vendor product name of the radio equipment <br /><strong>version:</strong> The version of the radio equipment <br /><strong>longitude:</strong> The longitude (in degrees) of the radio equipment, if known. Min = -180, Max = 180 <br /><strong>latitude:</strong> The latitude (in degrees) of the radio equipment, if known. Min = -90, Max = 90 <br /><strong>location:</strong> The location of the radio equipment <br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>communicationState:</strong> The communication status of the radio equipment <br /><strong>availabilityStates:</strong> The availability state <br /><strong>objectDetails:</strong> Generic properties of the radio equipment <br /><strong>macAddress:</strong> The Mac address of the radio equipment<br /><strong>clliCode:</strong> Common Language Location Identifier (CLLI) code value for the system <br /><br />Examples:<br />Get all radio equipment: GET /v1/radioEquipment<br />"
|
|
1788
|
+
operationId: getRadioEquipmentsUsingGET
|
|
1789
|
+
parameters:
|
|
1790
|
+
- name: fdns
|
|
1791
|
+
in: query
|
|
1792
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
1793
|
+
style: form
|
|
1794
|
+
explode: true
|
|
1795
|
+
schema:
|
|
1796
|
+
type: string
|
|
1797
|
+
- name: filter
|
|
1798
|
+
in: query
|
|
1799
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1800
|
+
style: form
|
|
1801
|
+
explode: true
|
|
1802
|
+
schema:
|
|
1803
|
+
type: string
|
|
1804
|
+
- name: limit
|
|
1805
|
+
in: query
|
|
1806
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
1807
|
+
style: form
|
|
1808
|
+
explode: true
|
|
1809
|
+
schema:
|
|
1810
|
+
type: integer
|
|
1811
|
+
format: int32
|
|
1812
|
+
default: 300
|
|
1813
|
+
- name: offset
|
|
1814
|
+
in: query
|
|
1815
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
1816
|
+
style: form
|
|
1817
|
+
explode: true
|
|
1818
|
+
schema:
|
|
1819
|
+
type: integer
|
|
1820
|
+
format: int32
|
|
1821
|
+
default: 0
|
|
1822
|
+
responses:
|
|
1823
|
+
'200':
|
|
1824
|
+
description: OK - Request executed successfully
|
|
1825
|
+
headers: {}
|
|
1826
|
+
content:
|
|
1827
|
+
application/json:
|
|
1828
|
+
schema:
|
|
1829
|
+
type: array
|
|
1830
|
+
items:
|
|
1831
|
+
$ref: '#/components/schemas/RadioEquipment'
|
|
1832
|
+
description: ''
|
|
1833
|
+
'400':
|
|
1834
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1835
|
+
headers: {}
|
|
1836
|
+
content: {}
|
|
1837
|
+
'401':
|
|
1838
|
+
description: Unauthorized - Authentication rejected
|
|
1839
|
+
headers: {}
|
|
1840
|
+
content: {}
|
|
1841
|
+
'404':
|
|
1842
|
+
description: Not Found - URL or resource does not exist
|
|
1843
|
+
headers: {}
|
|
1844
|
+
content: {}
|
|
1845
|
+
'405':
|
|
1846
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1847
|
+
headers: {}
|
|
1848
|
+
content: {}
|
|
1849
|
+
'500':
|
|
1850
|
+
description: Internal Server Error - Server error
|
|
1851
|
+
headers: {}
|
|
1852
|
+
content: {}
|
|
1853
|
+
deprecated: false
|
|
1854
|
+
security:
|
|
1855
|
+
- RESTToken:
|
|
1856
|
+
- global
|
|
1857
|
+
/v1/radioEquipment/{radioEquipmentFdn}:
|
|
1858
|
+
get:
|
|
1859
|
+
tags:
|
|
1860
|
+
- radioEquipment
|
|
1861
|
+
summary: getRadioEquipmentUsingGET
|
|
1862
|
+
description: Returns detailed information for the specified radio equipment.<br /><br />Example:<br />
|
|
1863
|
+
operationId: getRadioEquipmentUsingGET
|
|
1864
|
+
parameters:
|
|
1865
|
+
- name: radioEquipmentFdn
|
|
1866
|
+
in: path
|
|
1867
|
+
description: radioEquipmentFdn
|
|
1868
|
+
required: true
|
|
1869
|
+
style: simple
|
|
1870
|
+
schema:
|
|
1871
|
+
type: string
|
|
1872
|
+
responses:
|
|
1873
|
+
'200':
|
|
1874
|
+
description: OK - Request executed successfully
|
|
1875
|
+
headers: {}
|
|
1876
|
+
content:
|
|
1877
|
+
application/json:
|
|
1878
|
+
schema:
|
|
1879
|
+
$ref: '#/components/schemas/RadioEquipment'
|
|
1880
|
+
'400':
|
|
1881
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1882
|
+
headers: {}
|
|
1883
|
+
content: {}
|
|
1884
|
+
'401':
|
|
1885
|
+
description: Unauthorized - Authentication rejected
|
|
1886
|
+
headers: {}
|
|
1887
|
+
content: {}
|
|
1888
|
+
'403':
|
|
1889
|
+
description: Forbidden - No user access to the resource
|
|
1890
|
+
headers: {}
|
|
1891
|
+
content: {}
|
|
1892
|
+
'404':
|
|
1893
|
+
description: Not Found - URL or resource does not exist
|
|
1894
|
+
headers: {}
|
|
1895
|
+
content: {}
|
|
1896
|
+
'405':
|
|
1897
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1898
|
+
headers: {}
|
|
1899
|
+
content: {}
|
|
1900
|
+
'422':
|
|
1901
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
1902
|
+
headers: {}
|
|
1903
|
+
content: {}
|
|
1904
|
+
'500':
|
|
1905
|
+
description: Internal Server Error - Server error
|
|
1906
|
+
headers: {}
|
|
1907
|
+
content: {}
|
|
1908
|
+
deprecated: false
|
|
1909
|
+
security:
|
|
1910
|
+
- RESTToken:
|
|
1911
|
+
- global
|
|
1912
|
+
/v1/shelves:
|
|
1913
|
+
get:
|
|
1914
|
+
tags:
|
|
1915
|
+
- shelves
|
|
1916
|
+
summary: getShelvesUsingGET
|
|
1917
|
+
description: "Returns a paged list of specific shelves. The size of each page is determined by the 'limit' query parameter. The list will contain the FDN of each resulting shelf. Not providing a filter will return all shelves.<br /><br /><strong>Filterable properties:</strong> <br /><strong>sourceType:</strong> The type of the source system. For example: <i>nfmp</i> <br /><strong>sourceSystem:</strong> The partial FDN identifying the source system. For example: <i>fdn:realm:sam</i> <br /><strong>name:</strong> The user friendly visible name <br /><strong>neName:</strong> The name of the Network Element containing the Shelf <br /><strong>neId:</strong> The id of the Network Element containing the Shelf <br /><strong>description:</strong> The detailed description of the Shelf <br /><strong>positionId:</strong> The relative position of the Shelf that determines the order in which to show it in the source system UI<br /><strong>position:</strong> A formatted name that describes the position of the Shelf within the Network Element<br /><strong>adminState:</strong> The administrative state <br /><strong>operState:</strong> The operational state <br /><strong>standbyState:</strong> The standby state <br /><strong>availabilityStates:</strong> The availability state <br /><strong>stateReasons:</strong> A set of specific reasons why the Shelf is in this state <br /><strong>objectDetails:</strong> Generic properties of this Shelf <br /><strong>manufacturer:</strong> The vendor of the Shelf <br /><strong>serialNumber:</strong> The serial number of the Shelf provided by the manufacturer <br /><strong>partNumber:</strong> The part number of the Shelf provided by the manufacturer <br /><strong>manufacturerAssemblyNumber:</strong> The assembly number of the Shelf provided by the manufacturer <br /><strong>manufactureDate:</strong> The date of manufacture of the Shelf <br /><strong>manufacturingDeviations:</strong> The manufacturing deviations of the Shelf provided by the manufacturer <br /><strong>macAddress:</strong> The base MAC Address of the Shelf <br /><strong>hwMacAddress:</strong> The Hardware MAC Address of the Shelf <br /><br />Examples:<br />Get all shelves: GET /v1/shelves<br />Get all shelves, using a comma-separated list of FDNs: GET /v1/shelves?fdns=fdn:model:equipment:Equipment:2122,fdn:model:equipment:Equipment:2124<br />Get all shelves, with filter by standbyState: GET /v1/shelves?filter=standbyState%3D'providingService'<br />Get all shelves, with filter by adminState: GET /v1/shelves?filter=adminState%3D'unlocked'<br />Get all shelves, with filter by combined criteria: GET /v1/shelves?filter=standbyState%3D'providingService'%20AND%20NOT%20(adminState%3D'locked')"
|
|
1918
|
+
operationId: getShelvesUsingGET
|
|
1919
|
+
parameters:
|
|
1920
|
+
- name: fdns
|
|
1921
|
+
in: query
|
|
1922
|
+
description: A comma-separated list of the Fully Distinguished Names of the NSP objects to query for.
|
|
1923
|
+
style: form
|
|
1924
|
+
explode: true
|
|
1925
|
+
schema:
|
|
1926
|
+
type: string
|
|
1927
|
+
- name: filter
|
|
1928
|
+
in: query
|
|
1929
|
+
description: "The criteria to use for filtering. Filter parameter supports NBI standard query language. \n\nFor example, non-encoded filter string: ?filter=name='name' AND NOT (description LIKE '%description%')"
|
|
1930
|
+
style: form
|
|
1931
|
+
explode: true
|
|
1932
|
+
schema:
|
|
1933
|
+
type: string
|
|
1934
|
+
- name: limit
|
|
1935
|
+
in: query
|
|
1936
|
+
description: 'The limit on the number of objects returned (max: 1000)'
|
|
1937
|
+
style: form
|
|
1938
|
+
explode: true
|
|
1939
|
+
schema:
|
|
1940
|
+
type: integer
|
|
1941
|
+
format: int32
|
|
1942
|
+
default: 300
|
|
1943
|
+
- name: offset
|
|
1944
|
+
in: query
|
|
1945
|
+
description: 'Start row for paged data (max: total number of objects)'
|
|
1946
|
+
style: form
|
|
1947
|
+
explode: true
|
|
1948
|
+
schema:
|
|
1949
|
+
type: integer
|
|
1950
|
+
format: int32
|
|
1951
|
+
default: 0
|
|
1952
|
+
responses:
|
|
1953
|
+
'200':
|
|
1954
|
+
description: OK - Request executed successfully
|
|
1955
|
+
headers: {}
|
|
1956
|
+
content:
|
|
1957
|
+
application/json:
|
|
1958
|
+
schema:
|
|
1959
|
+
type: array
|
|
1960
|
+
items:
|
|
1961
|
+
$ref: '#/components/schemas/Shelf'
|
|
1962
|
+
description: ''
|
|
1963
|
+
'400':
|
|
1964
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
1965
|
+
headers: {}
|
|
1966
|
+
content: {}
|
|
1967
|
+
'401':
|
|
1968
|
+
description: Unauthorized - Authentication rejected
|
|
1969
|
+
headers: {}
|
|
1970
|
+
content: {}
|
|
1971
|
+
'404':
|
|
1972
|
+
description: Not Found - URL or resource does not exist
|
|
1973
|
+
headers: {}
|
|
1974
|
+
content: {}
|
|
1975
|
+
'405':
|
|
1976
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
1977
|
+
headers: {}
|
|
1978
|
+
content: {}
|
|
1979
|
+
'500':
|
|
1980
|
+
description: Internal Server Error - Server error
|
|
1981
|
+
headers: {}
|
|
1982
|
+
content: {}
|
|
1983
|
+
deprecated: false
|
|
1984
|
+
security:
|
|
1985
|
+
- RESTToken:
|
|
1986
|
+
- global
|
|
1987
|
+
/v1/shelves/{shelfFdn}:
|
|
1988
|
+
get:
|
|
1989
|
+
tags:
|
|
1990
|
+
- shelves
|
|
1991
|
+
summary: getShelfUsingGET
|
|
1992
|
+
description: Returns detailed information for the specified shelf.<br /><br />Example:<br />GET /v1/shelves/fdn:model:equipment:Equipment:2122
|
|
1993
|
+
operationId: getShelfUsingGET
|
|
1994
|
+
parameters:
|
|
1995
|
+
- name: shelfFdn
|
|
1996
|
+
in: path
|
|
1997
|
+
description: shelfFdn
|
|
1998
|
+
required: true
|
|
1999
|
+
style: simple
|
|
2000
|
+
schema:
|
|
2001
|
+
type: string
|
|
2002
|
+
responses:
|
|
2003
|
+
'200':
|
|
2004
|
+
description: OK - Request executed successfully
|
|
2005
|
+
headers: {}
|
|
2006
|
+
content:
|
|
2007
|
+
application/json:
|
|
2008
|
+
schema:
|
|
2009
|
+
$ref: '#/components/schemas/Shelf'
|
|
2010
|
+
'400':
|
|
2011
|
+
description: Bad Request - Malformed content or invalid parameter data provided
|
|
2012
|
+
headers: {}
|
|
2013
|
+
content: {}
|
|
2014
|
+
'401':
|
|
2015
|
+
description: Unauthorized - Authentication rejected
|
|
2016
|
+
headers: {}
|
|
2017
|
+
content: {}
|
|
2018
|
+
'403':
|
|
2019
|
+
description: Forbidden - No user access to the resource
|
|
2020
|
+
headers: {}
|
|
2021
|
+
content: {}
|
|
2022
|
+
'404':
|
|
2023
|
+
description: Not Found - URL or resource does not exist
|
|
2024
|
+
headers: {}
|
|
2025
|
+
content: {}
|
|
2026
|
+
'405':
|
|
2027
|
+
description: Method Not Allowed - HTTP method not allowed for this endpoint
|
|
2028
|
+
headers: {}
|
|
2029
|
+
content: {}
|
|
2030
|
+
'422':
|
|
2031
|
+
description: Unprocessable Entity - Invalid FDN provided
|
|
2032
|
+
headers: {}
|
|
2033
|
+
content: {}
|
|
2034
|
+
'500':
|
|
2035
|
+
description: Internal Server Error - Server error
|
|
2036
|
+
headers: {}
|
|
2037
|
+
content: {}
|
|
2038
|
+
deprecated: false
|
|
2039
|
+
security:
|
|
2040
|
+
- RESTToken:
|
|
2041
|
+
- global
|
|
2042
|
+
components:
|
|
2043
|
+
schemas:
|
|
2044
|
+
Card:
|
|
2045
|
+
title: Card
|
|
2046
|
+
required:
|
|
2047
|
+
- fdn
|
|
2048
|
+
- sourceType
|
|
2049
|
+
- sourceSystem
|
|
2050
|
+
- sources
|
|
2051
|
+
- name
|
|
2052
|
+
- neName
|
|
2053
|
+
- neId
|
|
2054
|
+
- positionId
|
|
2055
|
+
- position
|
|
2056
|
+
- adminState
|
|
2057
|
+
- operState
|
|
2058
|
+
- standbyState
|
|
2059
|
+
- availabilityStates
|
|
2060
|
+
type: object
|
|
2061
|
+
properties:
|
|
2062
|
+
links:
|
|
2063
|
+
type: array
|
|
2064
|
+
items:
|
|
2065
|
+
$ref: '#/components/schemas/Link'
|
|
2066
|
+
description: ''
|
|
2067
|
+
xml:
|
|
2068
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2069
|
+
attribute: false
|
|
2070
|
+
wrapped: false
|
|
2071
|
+
fdn:
|
|
2072
|
+
type: string
|
|
2073
|
+
description: The Fully Distinguished Name of this Card.
|
|
2074
|
+
sourceType:
|
|
2075
|
+
allOf:
|
|
2076
|
+
- $ref: '#/components/schemas/SourceType'
|
|
2077
|
+
- description: The type of the source system where this Card is sourced from.
|
|
2078
|
+
sourceSystem:
|
|
2079
|
+
type: string
|
|
2080
|
+
description: The source system where this Card is sourced from.
|
|
2081
|
+
sources:
|
|
2082
|
+
type: array
|
|
2083
|
+
items:
|
|
2084
|
+
type: string
|
|
2085
|
+
description: The Fully Distinguished Names of the Cards from the source system associated to this Card.
|
|
2086
|
+
name:
|
|
2087
|
+
type: string
|
|
2088
|
+
description: The name of this Card, as defined by the source system.
|
|
2089
|
+
neName:
|
|
2090
|
+
type: string
|
|
2091
|
+
description: The name of the Network Element containing this Card, as defined by the source system.
|
|
2092
|
+
neId:
|
|
2093
|
+
type: string
|
|
2094
|
+
description: The id of the Network Element containing this Card, as defined by the source system.
|
|
2095
|
+
description:
|
|
2096
|
+
type: string
|
|
2097
|
+
description: The detailed description of this Card.
|
|
2098
|
+
positionId:
|
|
2099
|
+
type: integer
|
|
2100
|
+
description: The relative position of the Card, that determines the order in which to show it in the source system UI.
|
|
2101
|
+
format: int64
|
|
2102
|
+
position:
|
|
2103
|
+
type: string
|
|
2104
|
+
description: A formatted name that describes the position of the Card within the Network Element.
|
|
2105
|
+
adminState:
|
|
2106
|
+
allOf:
|
|
2107
|
+
- $ref: '#/components/schemas/AdminState'
|
|
2108
|
+
- description: The administrative state of this Card. Refer to the X.731 standard.
|
|
2109
|
+
operState:
|
|
2110
|
+
allOf:
|
|
2111
|
+
- $ref: '#/components/schemas/OperState'
|
|
2112
|
+
- description: The operational state of this Card. Refer to the X.731 standard.
|
|
2113
|
+
standbyState:
|
|
2114
|
+
allOf:
|
|
2115
|
+
- $ref: '#/components/schemas/StandbyState'
|
|
2116
|
+
- description: The standby state of this Card. Refer to the X.731 standard.
|
|
2117
|
+
availabilityStates:
|
|
2118
|
+
type: array
|
|
2119
|
+
items:
|
|
2120
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2121
|
+
description: The availability states of this Card. Refer to the X.731 standard.
|
|
2122
|
+
stateReasons:
|
|
2123
|
+
type: array
|
|
2124
|
+
items:
|
|
2125
|
+
type: string
|
|
2126
|
+
description: A set of specific reasons why the Card is in this state.
|
|
2127
|
+
objectDetails:
|
|
2128
|
+
type: object
|
|
2129
|
+
additionalProperties:
|
|
2130
|
+
type: string
|
|
2131
|
+
description: Generic properties of this Card, specific to the Network Supervision application.
|
|
2132
|
+
manufacturer:
|
|
2133
|
+
type: string
|
|
2134
|
+
description: The vendor of the Card.
|
|
2135
|
+
serialNumber:
|
|
2136
|
+
type: string
|
|
2137
|
+
description: The serial number of the Card provided by the manufacturer.
|
|
2138
|
+
partNumber:
|
|
2139
|
+
type: string
|
|
2140
|
+
description: The part number of the Card provided by the manufacturer.
|
|
2141
|
+
manufacturerAssemblyNumber:
|
|
2142
|
+
type: string
|
|
2143
|
+
description: The assembly number of the Card provided by the manufacturer.
|
|
2144
|
+
manufactureDate:
|
|
2145
|
+
type: string
|
|
2146
|
+
description: The date of manufacture of the Card.
|
|
2147
|
+
manufacturingDeviations:
|
|
2148
|
+
type: string
|
|
2149
|
+
description: The manufacturing deviations of the Card provided by the manufacturer.
|
|
2150
|
+
macAddress:
|
|
2151
|
+
type: string
|
|
2152
|
+
description: The Base MAC Address of the Card
|
|
2153
|
+
hwMacAddress:
|
|
2154
|
+
type: string
|
|
2155
|
+
description: The Hardware MAC Address of the Card
|
|
2156
|
+
cardDetails:
|
|
2157
|
+
$ref: '#/components/schemas/CardDetails'
|
|
2158
|
+
CardSlot:
|
|
2159
|
+
title: CardSlot
|
|
2160
|
+
required:
|
|
2161
|
+
- fdn
|
|
2162
|
+
- sourceType
|
|
2163
|
+
- sourceSystem
|
|
2164
|
+
- sources
|
|
2165
|
+
- name
|
|
2166
|
+
- neName
|
|
2167
|
+
- neId
|
|
2168
|
+
- positionId
|
|
2169
|
+
- position
|
|
2170
|
+
- adminState
|
|
2171
|
+
- operState
|
|
2172
|
+
- standbyState
|
|
2173
|
+
- availabilityStates
|
|
2174
|
+
- provisionedType
|
|
2175
|
+
- actualType
|
|
2176
|
+
- holderState
|
|
2177
|
+
type: object
|
|
2178
|
+
properties:
|
|
2179
|
+
links:
|
|
2180
|
+
type: array
|
|
2181
|
+
items:
|
|
2182
|
+
$ref: '#/components/schemas/Link'
|
|
2183
|
+
description: ''
|
|
2184
|
+
xml:
|
|
2185
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2186
|
+
attribute: false
|
|
2187
|
+
wrapped: false
|
|
2188
|
+
fdn:
|
|
2189
|
+
type: string
|
|
2190
|
+
description: The Fully Distinguished Name of this Card Slot.
|
|
2191
|
+
sourceType:
|
|
2192
|
+
allOf:
|
|
2193
|
+
- $ref: '#/components/schemas/SourceType2'
|
|
2194
|
+
- description: The type of the source system where this Card Slot is sourced from.
|
|
2195
|
+
sourceSystem:
|
|
2196
|
+
type: string
|
|
2197
|
+
description: The source system where this Card Slot is sourced from.
|
|
2198
|
+
sources:
|
|
2199
|
+
type: array
|
|
2200
|
+
items:
|
|
2201
|
+
type: string
|
|
2202
|
+
description: The Fully Distinguished Names of the Card Slots from the source system associated to this Card Slot.
|
|
2203
|
+
name:
|
|
2204
|
+
type: string
|
|
2205
|
+
description: The name of this Card Slot, as defined by the source system.
|
|
2206
|
+
neName:
|
|
2207
|
+
type: string
|
|
2208
|
+
description: The name of the Network Element containing this Card Slot, as defined by the source system.
|
|
2209
|
+
neId:
|
|
2210
|
+
type: string
|
|
2211
|
+
description: The id of the Network Element containing this Card Slot, as defined by the source system.
|
|
2212
|
+
description:
|
|
2213
|
+
type: string
|
|
2214
|
+
description: The detailed description of this Card Slot.
|
|
2215
|
+
positionId:
|
|
2216
|
+
type: integer
|
|
2217
|
+
description: The relative position of the Card Slot, that determines the order in which to show it in the source system UI.
|
|
2218
|
+
format: int64
|
|
2219
|
+
position:
|
|
2220
|
+
type: string
|
|
2221
|
+
description: A formatted name that describes the position of the Card Slot within the Network Element.
|
|
2222
|
+
adminState:
|
|
2223
|
+
allOf:
|
|
2224
|
+
- $ref: '#/components/schemas/AdminState1'
|
|
2225
|
+
- description: The administrative state of this Card Slot. Refer to the X.731 standard.
|
|
2226
|
+
operState:
|
|
2227
|
+
allOf:
|
|
2228
|
+
- $ref: '#/components/schemas/OperState1'
|
|
2229
|
+
- description: The operational state of this Card Slot. Refer to the X.731 standard.
|
|
2230
|
+
standbyState:
|
|
2231
|
+
allOf:
|
|
2232
|
+
- $ref: '#/components/schemas/StandbyState1'
|
|
2233
|
+
- description: The standby state of this Card Slot. Refer to the X.731 standard.
|
|
2234
|
+
availabilityStates:
|
|
2235
|
+
type: array
|
|
2236
|
+
items:
|
|
2237
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2238
|
+
description: The availability states of this Card Slot. Refer to the X.731 standard.
|
|
2239
|
+
stateReasons:
|
|
2240
|
+
type: array
|
|
2241
|
+
items:
|
|
2242
|
+
type: string
|
|
2243
|
+
description: A set of specific reasons why the Card Slot is in this state.
|
|
2244
|
+
objectDetails:
|
|
2245
|
+
type: object
|
|
2246
|
+
additionalProperties:
|
|
2247
|
+
type: string
|
|
2248
|
+
description: Generic properties of this Card Slot, specific to the Network Supervision application.
|
|
2249
|
+
manufacturer:
|
|
2250
|
+
type: string
|
|
2251
|
+
description: The vendor of the Card Slot.
|
|
2252
|
+
serialNumber:
|
|
2253
|
+
type: string
|
|
2254
|
+
description: The serial number of the Card Slot provided by the manufacturer.
|
|
2255
|
+
partNumber:
|
|
2256
|
+
type: string
|
|
2257
|
+
description: The part number of the Card Slot provided by the manufacturer.
|
|
2258
|
+
manufacturerAssemblyNumber:
|
|
2259
|
+
type: string
|
|
2260
|
+
description: The assembly number of the Card Slot provided by the manufacturer.
|
|
2261
|
+
manufactureDate:
|
|
2262
|
+
type: string
|
|
2263
|
+
description: The date of manufacture of the Card Slot.
|
|
2264
|
+
manufacturingDeviations:
|
|
2265
|
+
type: string
|
|
2266
|
+
description: The manufacturing deviations of the Card Slot provided by the manufacturer.
|
|
2267
|
+
macAddress:
|
|
2268
|
+
type: string
|
|
2269
|
+
description: The Base MAC Address of the Card Slot
|
|
2270
|
+
hwMacAddress:
|
|
2271
|
+
type: string
|
|
2272
|
+
description: The Hardware MAC Address of the Card Slot
|
|
2273
|
+
provisionedType:
|
|
2274
|
+
type: string
|
|
2275
|
+
description: The type of Card provisioned in this Card Slot.
|
|
2276
|
+
actualType:
|
|
2277
|
+
type: string
|
|
2278
|
+
description: The type of Card present in this Card Slot.
|
|
2279
|
+
holderState:
|
|
2280
|
+
type: string
|
|
2281
|
+
description: The status of the Card Slot.
|
|
2282
|
+
CardDetails:
|
|
2283
|
+
title: CardDetails
|
|
2284
|
+
type: object
|
|
2285
|
+
properties:
|
|
2286
|
+
fdn:
|
|
2287
|
+
type: string
|
|
2288
|
+
example: fdn:model:equipment:CardDetails:2203
|
|
2289
|
+
sourceType:
|
|
2290
|
+
allOf:
|
|
2291
|
+
- $ref: '#/components/schemas/SourceType1'
|
|
2292
|
+
- example: nfmp
|
|
2293
|
+
sourceSystem:
|
|
2294
|
+
type: string
|
|
2295
|
+
example: fdn:realm:sam
|
|
2296
|
+
sources:
|
|
2297
|
+
type: array
|
|
2298
|
+
items:
|
|
2299
|
+
type: string
|
|
2300
|
+
description: ''
|
|
2301
|
+
example:
|
|
2302
|
+
- fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card@cardDetails
|
|
2303
|
+
objectDetails:
|
|
2304
|
+
type: object
|
|
2305
|
+
additionalProperties:
|
|
2306
|
+
type: string
|
|
2307
|
+
cardType:
|
|
2308
|
+
type: string
|
|
2309
|
+
description: The type of this Card.
|
|
2310
|
+
example: 500g CPM / Switch Fabric 3
|
|
2311
|
+
equippedPorts:
|
|
2312
|
+
type: integer
|
|
2313
|
+
description: The number of ports equipped directly on this Card.
|
|
2314
|
+
format: int32
|
|
2315
|
+
example: 40
|
|
2316
|
+
capabilities:
|
|
2317
|
+
type: array
|
|
2318
|
+
items:
|
|
2319
|
+
type: string
|
|
2320
|
+
description: A set of specific capabilities of the Card.
|
|
2321
|
+
availableSlots:
|
|
2322
|
+
type: integer
|
|
2323
|
+
description: The number of available card slots on this Card.
|
|
2324
|
+
format: int32
|
|
2325
|
+
example: 2
|
|
2326
|
+
installedSlots:
|
|
2327
|
+
type: integer
|
|
2328
|
+
description: The number of installed slots on this Card.
|
|
2329
|
+
format: int32
|
|
2330
|
+
example: 1
|
|
2331
|
+
memorySize:
|
|
2332
|
+
type: integer
|
|
2333
|
+
description: The Memory Size of this Card in MB.
|
|
2334
|
+
format: int64
|
|
2335
|
+
example: 16392
|
|
2336
|
+
lastBootUpReason:
|
|
2337
|
+
type: string
|
|
2338
|
+
description: The last boot-up reason of this Card.
|
|
2339
|
+
example: Hard Reboot
|
|
2340
|
+
LAG:
|
|
2341
|
+
title: LAG
|
|
2342
|
+
required:
|
|
2343
|
+
- fdn
|
|
2344
|
+
- sourceType
|
|
2345
|
+
- sourceSystem
|
|
2346
|
+
- sources
|
|
2347
|
+
- lagId
|
|
2348
|
+
- neName
|
|
2349
|
+
- neId
|
|
2350
|
+
- name
|
|
2351
|
+
- encapType
|
|
2352
|
+
- adminState
|
|
2353
|
+
- operState
|
|
2354
|
+
- standbyState
|
|
2355
|
+
- parentNe
|
|
2356
|
+
type: object
|
|
2357
|
+
properties:
|
|
2358
|
+
links:
|
|
2359
|
+
type: array
|
|
2360
|
+
items:
|
|
2361
|
+
$ref: '#/components/schemas/Link'
|
|
2362
|
+
description: ''
|
|
2363
|
+
xml:
|
|
2364
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2365
|
+
attribute: false
|
|
2366
|
+
wrapped: false
|
|
2367
|
+
fdn:
|
|
2368
|
+
type: string
|
|
2369
|
+
description: The Fully Distinguished Name of this LAG.
|
|
2370
|
+
sourceType:
|
|
2371
|
+
allOf:
|
|
2372
|
+
- $ref: '#/components/schemas/SourceType3'
|
|
2373
|
+
- description: The type of the source system where this LAG is sourced from.
|
|
2374
|
+
sourceSystem:
|
|
2375
|
+
type: string
|
|
2376
|
+
description: The source system where this LAG is sourced from.
|
|
2377
|
+
sources:
|
|
2378
|
+
type: array
|
|
2379
|
+
items:
|
|
2380
|
+
type: string
|
|
2381
|
+
description: The Fully Distinguished Names of the LAGs from the source system associated to this LAG.
|
|
2382
|
+
lagId:
|
|
2383
|
+
type: string
|
|
2384
|
+
description: The short identifier of this LAG, as defined by the source system
|
|
2385
|
+
neName:
|
|
2386
|
+
type: string
|
|
2387
|
+
description: The name of this LAG. Is unique within the source system.
|
|
2388
|
+
neId:
|
|
2389
|
+
type: string
|
|
2390
|
+
description: The id of this LAG. Is unique within the source system.
|
|
2391
|
+
name:
|
|
2392
|
+
type: string
|
|
2393
|
+
description: The name of this LAG, as defined by the source system.
|
|
2394
|
+
description:
|
|
2395
|
+
type: string
|
|
2396
|
+
description: The detailed description of this LAG.
|
|
2397
|
+
configuredAddress:
|
|
2398
|
+
type: string
|
|
2399
|
+
description: The MAC Address of this LAG.
|
|
2400
|
+
encapType:
|
|
2401
|
+
allOf:
|
|
2402
|
+
- $ref: '#/components/schemas/EncapType'
|
|
2403
|
+
- description: The encapsulation type of this LAG.
|
|
2404
|
+
operationalSpeedUnits:
|
|
2405
|
+
type: string
|
|
2406
|
+
description: The units associated to the 'operationalSpeed' field value for this LAG.
|
|
2407
|
+
operationalSpeed:
|
|
2408
|
+
type: number
|
|
2409
|
+
description: The total operational speed of this LAG, in units specified by the 'operationalSpeedUnits' field value.
|
|
2410
|
+
lagMode:
|
|
2411
|
+
allOf:
|
|
2412
|
+
- $ref: '#/components/schemas/LagMode'
|
|
2413
|
+
- description: The mode of this LAG.
|
|
2414
|
+
adminState:
|
|
2415
|
+
allOf:
|
|
2416
|
+
- $ref: '#/components/schemas/AdminState2'
|
|
2417
|
+
- description: The administrative state of this LAG. Refer to the X.731 standard.
|
|
2418
|
+
operState:
|
|
2419
|
+
allOf:
|
|
2420
|
+
- $ref: '#/components/schemas/OperState2'
|
|
2421
|
+
- description: The operational state of this LAG. Refer to the X.731 standard.
|
|
2422
|
+
standbyState:
|
|
2423
|
+
allOf:
|
|
2424
|
+
- $ref: '#/components/schemas/StandbyState2'
|
|
2425
|
+
- description: The standby state of this LAG. Refer to the X.731 standard
|
|
2426
|
+
availabilityStates:
|
|
2427
|
+
type: array
|
|
2428
|
+
items:
|
|
2429
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2430
|
+
description: The availability states of this LAG. Refer to the X.731 standard.
|
|
2431
|
+
stateReasons:
|
|
2432
|
+
type: array
|
|
2433
|
+
items:
|
|
2434
|
+
type: string
|
|
2435
|
+
description: A set of specific reasons why the LAG is in this state.
|
|
2436
|
+
objectDetails:
|
|
2437
|
+
type: object
|
|
2438
|
+
additionalProperties:
|
|
2439
|
+
type: string
|
|
2440
|
+
description: Generic properties of this LAG, specific to the Network Supervision application
|
|
2441
|
+
members:
|
|
2442
|
+
type: array
|
|
2443
|
+
items:
|
|
2444
|
+
$ref: '#/components/schemas/LAGMemberDetails'
|
|
2445
|
+
description: ''
|
|
2446
|
+
multiChassisLAGMembers:
|
|
2447
|
+
type: array
|
|
2448
|
+
items:
|
|
2449
|
+
$ref: '#/components/schemas/MultiChassisLAGMember'
|
|
2450
|
+
description: ''
|
|
2451
|
+
parentNe:
|
|
2452
|
+
type: string
|
|
2453
|
+
description: The Fully Distinguished Name of the Network Element containing this LAG.
|
|
2454
|
+
parent:
|
|
2455
|
+
type: string
|
|
2456
|
+
description: The Fully Distinguished Name of the Radio Equipment containing this LAG.
|
|
2457
|
+
LAGMemberDetails:
|
|
2458
|
+
title: LAGMemberDetails
|
|
2459
|
+
type: object
|
|
2460
|
+
properties:
|
|
2461
|
+
encapType:
|
|
2462
|
+
type: string
|
|
2463
|
+
fdn:
|
|
2464
|
+
type: string
|
|
2465
|
+
lagId:
|
|
2466
|
+
type: string
|
|
2467
|
+
objectDetails:
|
|
2468
|
+
type: object
|
|
2469
|
+
additionalProperties:
|
|
2470
|
+
type: string
|
|
2471
|
+
portFdn:
|
|
2472
|
+
type: string
|
|
2473
|
+
portName:
|
|
2474
|
+
type: string
|
|
2475
|
+
priority:
|
|
2476
|
+
type: integer
|
|
2477
|
+
format: int64
|
|
2478
|
+
sourceSystem:
|
|
2479
|
+
type: string
|
|
2480
|
+
sourceType:
|
|
2481
|
+
type: string
|
|
2482
|
+
sources:
|
|
2483
|
+
type: array
|
|
2484
|
+
items:
|
|
2485
|
+
type: string
|
|
2486
|
+
description: ''
|
|
2487
|
+
standbyState:
|
|
2488
|
+
type: string
|
|
2489
|
+
Link:
|
|
2490
|
+
title: Link
|
|
2491
|
+
type: object
|
|
2492
|
+
properties:
|
|
2493
|
+
href:
|
|
2494
|
+
type: string
|
|
2495
|
+
xml:
|
|
2496
|
+
name: href
|
|
2497
|
+
attribute: true
|
|
2498
|
+
wrapped: false
|
|
2499
|
+
rel:
|
|
2500
|
+
type: string
|
|
2501
|
+
xml:
|
|
2502
|
+
name: rel
|
|
2503
|
+
attribute: true
|
|
2504
|
+
wrapped: false
|
|
2505
|
+
templated:
|
|
2506
|
+
type: boolean
|
|
2507
|
+
MultiChassisLAGMember:
|
|
2508
|
+
title: MultiChassisLAGMember
|
|
2509
|
+
type: object
|
|
2510
|
+
properties:
|
|
2511
|
+
description:
|
|
2512
|
+
type: string
|
|
2513
|
+
fdn:
|
|
2514
|
+
type: string
|
|
2515
|
+
lacpKey:
|
|
2516
|
+
type: integer
|
|
2517
|
+
format: int64
|
|
2518
|
+
objectDetails:
|
|
2519
|
+
type: object
|
|
2520
|
+
additionalProperties:
|
|
2521
|
+
type: string
|
|
2522
|
+
peerIpAddress:
|
|
2523
|
+
type: string
|
|
2524
|
+
peerNeId:
|
|
2525
|
+
type: string
|
|
2526
|
+
remoteLagId:
|
|
2527
|
+
type: string
|
|
2528
|
+
sourceSystem:
|
|
2529
|
+
type: string
|
|
2530
|
+
sourceType:
|
|
2531
|
+
type: string
|
|
2532
|
+
sources:
|
|
2533
|
+
type: array
|
|
2534
|
+
items:
|
|
2535
|
+
type: string
|
|
2536
|
+
description: ''
|
|
2537
|
+
standbyState:
|
|
2538
|
+
type: string
|
|
2539
|
+
systemId:
|
|
2540
|
+
type: string
|
|
2541
|
+
systemPriority:
|
|
2542
|
+
type: integer
|
|
2543
|
+
format: int64
|
|
2544
|
+
NetworkElement:
|
|
2545
|
+
title: NetworkElement
|
|
2546
|
+
required:
|
|
2547
|
+
- fdn
|
|
2548
|
+
- sourceType
|
|
2549
|
+
- sourceSystem
|
|
2550
|
+
- sources
|
|
2551
|
+
- name
|
|
2552
|
+
- neName
|
|
2553
|
+
- neId
|
|
2554
|
+
- ipAddress
|
|
2555
|
+
- type
|
|
2556
|
+
- product
|
|
2557
|
+
- version
|
|
2558
|
+
- resyncState
|
|
2559
|
+
- managedState
|
|
2560
|
+
- adminState
|
|
2561
|
+
- operState
|
|
2562
|
+
- standbyState
|
|
2563
|
+
- communicationState
|
|
2564
|
+
type: object
|
|
2565
|
+
properties:
|
|
2566
|
+
links:
|
|
2567
|
+
type: array
|
|
2568
|
+
items:
|
|
2569
|
+
$ref: '#/components/schemas/Link'
|
|
2570
|
+
description: ''
|
|
2571
|
+
xml:
|
|
2572
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2573
|
+
attribute: false
|
|
2574
|
+
wrapped: false
|
|
2575
|
+
fdn:
|
|
2576
|
+
type: string
|
|
2577
|
+
description: The Fully Distinguished Name of this Network Element.
|
|
2578
|
+
sourceType:
|
|
2579
|
+
allOf:
|
|
2580
|
+
- $ref: '#/components/schemas/SourceType4'
|
|
2581
|
+
- description: The type of the source system where this Network Element is sourced from.
|
|
2582
|
+
sourceSystem:
|
|
2583
|
+
type: string
|
|
2584
|
+
description: The source system where this Network Element is sourced from.
|
|
2585
|
+
sources:
|
|
2586
|
+
type: array
|
|
2587
|
+
items:
|
|
2588
|
+
type: string
|
|
2589
|
+
description: The Fully Distinguished Names of the Network Elements from the source system associated to this Network Element.
|
|
2590
|
+
name:
|
|
2591
|
+
type: string
|
|
2592
|
+
description: The name of this Network Element, as defined by the source system.
|
|
2593
|
+
neName:
|
|
2594
|
+
type: string
|
|
2595
|
+
description: The name of this Network Element. Is unique within the source system.
|
|
2596
|
+
neId:
|
|
2597
|
+
type: string
|
|
2598
|
+
description: The identifier of this Network Element. Is unique within the source system.
|
|
2599
|
+
description:
|
|
2600
|
+
type: string
|
|
2601
|
+
description: The detailed description of this Network Element.
|
|
2602
|
+
ipAddress:
|
|
2603
|
+
type: string
|
|
2604
|
+
description: The management IP address of this Network Element.
|
|
2605
|
+
type:
|
|
2606
|
+
type: string
|
|
2607
|
+
description: The type of this Network Element.
|
|
2608
|
+
product:
|
|
2609
|
+
type: string
|
|
2610
|
+
description: The vendor product name of this Network Element.
|
|
2611
|
+
version:
|
|
2612
|
+
type: string
|
|
2613
|
+
description: The version of this Network Element.
|
|
2614
|
+
resyncState:
|
|
2615
|
+
allOf:
|
|
2616
|
+
- $ref: '#/components/schemas/ResyncState'
|
|
2617
|
+
- description: The resynchronization status of this Network Element.
|
|
2618
|
+
managedState:
|
|
2619
|
+
allOf:
|
|
2620
|
+
- $ref: '#/components/schemas/ManagedState'
|
|
2621
|
+
- description: The management state of this Network Element.
|
|
2622
|
+
longitude:
|
|
2623
|
+
type: number
|
|
2624
|
+
description: The longitude (in degrees) of this Network Element, if known. Min = -180, Max = 180
|
|
2625
|
+
latitude:
|
|
2626
|
+
type: number
|
|
2627
|
+
description: The latitude (in degrees) of this Network Element, if known. Min = -90, Max = 90
|
|
2628
|
+
location:
|
|
2629
|
+
type: string
|
|
2630
|
+
description: The location of this Network Element.
|
|
2631
|
+
topologyGroup:
|
|
2632
|
+
type: string
|
|
2633
|
+
description: The Fully Distinguished Name of the topology group that this Network Element belongs to, if any.
|
|
2634
|
+
adminState:
|
|
2635
|
+
allOf:
|
|
2636
|
+
- $ref: '#/components/schemas/AdminState3'
|
|
2637
|
+
- description: The administrative state of this Network Element. Refer to the X.731 standard.
|
|
2638
|
+
operState:
|
|
2639
|
+
allOf:
|
|
2640
|
+
- $ref: '#/components/schemas/OperState3'
|
|
2641
|
+
- description: The operational state of this Network Element. Refer to the X.731 standard.
|
|
2642
|
+
standbyState:
|
|
2643
|
+
allOf:
|
|
2644
|
+
- $ref: '#/components/schemas/StandbyState3'
|
|
2645
|
+
- description: The standby state of this Network Element. Refer to the X.731 standard.
|
|
2646
|
+
availabilityStates:
|
|
2647
|
+
type: array
|
|
2648
|
+
items:
|
|
2649
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2650
|
+
description: The availability states of this Network Element. Refer to the X.731 standard.
|
|
2651
|
+
objectDetails:
|
|
2652
|
+
type: object
|
|
2653
|
+
additionalProperties:
|
|
2654
|
+
type: string
|
|
2655
|
+
description: Generic properties of this Network Element, specific to the Network Supervision application.
|
|
2656
|
+
networkType:
|
|
2657
|
+
allOf:
|
|
2658
|
+
- $ref: '#/components/schemas/NetworkType'
|
|
2659
|
+
- description: The type of network this Network Element is part of.
|
|
2660
|
+
communicationState:
|
|
2661
|
+
allOf:
|
|
2662
|
+
- $ref: '#/components/schemas/CommunicationState'
|
|
2663
|
+
- description: The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols.
|
|
2664
|
+
communicationStateDetails:
|
|
2665
|
+
type: object
|
|
2666
|
+
additionalProperties:
|
|
2667
|
+
$ref: '#/components/schemas/ReachabilityStatus'
|
|
2668
|
+
description: The reachability status of each supported management protocol of this Network Element.
|
|
2669
|
+
macAddress:
|
|
2670
|
+
type: string
|
|
2671
|
+
description: The Mac address of this Network Element.
|
|
2672
|
+
clliCode:
|
|
2673
|
+
type: string
|
|
2674
|
+
description: Common Language Location Identifier (CLLI) code value for the system.
|
|
2675
|
+
PhysicalLink:
|
|
2676
|
+
title: PhysicalLink
|
|
2677
|
+
required:
|
|
2678
|
+
- name
|
|
2679
|
+
- id
|
|
2680
|
+
- type
|
|
2681
|
+
- endpoints
|
|
2682
|
+
type: object
|
|
2683
|
+
properties:
|
|
2684
|
+
links:
|
|
2685
|
+
type: array
|
|
2686
|
+
items:
|
|
2687
|
+
$ref: '#/components/schemas/Link'
|
|
2688
|
+
description: ''
|
|
2689
|
+
xml:
|
|
2690
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2691
|
+
attribute: false
|
|
2692
|
+
wrapped: false
|
|
2693
|
+
sourceType:
|
|
2694
|
+
type: string
|
|
2695
|
+
description: The type of the source system where this Service is sourced from. Read only.
|
|
2696
|
+
fdn:
|
|
2697
|
+
type: string
|
|
2698
|
+
description: The Fully Distinguished Name of the Physical Link. Read only.
|
|
2699
|
+
sourceSystem:
|
|
2700
|
+
type: string
|
|
2701
|
+
description: The source system where this Service is sourced from. Read only.
|
|
2702
|
+
sources:
|
|
2703
|
+
type: array
|
|
2704
|
+
items:
|
|
2705
|
+
type: string
|
|
2706
|
+
description: The Fully Distinguished Names of the Physical Links from the source system associated to this Physical Link. Read only.
|
|
2707
|
+
name:
|
|
2708
|
+
type: string
|
|
2709
|
+
description: The user-friendly name of this Physical Link. Mandatory property for creation.
|
|
2710
|
+
id:
|
|
2711
|
+
type: string
|
|
2712
|
+
description: The short identifier of this Physical Link. Mandatory property for creation.
|
|
2713
|
+
type:
|
|
2714
|
+
type: string
|
|
2715
|
+
description: The type of this Physical Link. Mandatory property for creation.
|
|
2716
|
+
rate:
|
|
2717
|
+
type: string
|
|
2718
|
+
description: The rate label of this Physical Link. Defaults to null value.
|
|
2719
|
+
actualRate:
|
|
2720
|
+
type: number
|
|
2721
|
+
description: The rate of this Physical Link, in units specified by the 'actualRateUnits' field value. Defaults to null value.
|
|
2722
|
+
actualRateUnits:
|
|
2723
|
+
allOf:
|
|
2724
|
+
- $ref: '#/components/schemas/ActualRateUnits'
|
|
2725
|
+
- description: The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.
|
|
2726
|
+
description:
|
|
2727
|
+
type: string
|
|
2728
|
+
description: The detailed description of this Physical Link.
|
|
2729
|
+
protection:
|
|
2730
|
+
allOf:
|
|
2731
|
+
- $ref: '#/components/schemas/Protection'
|
|
2732
|
+
- description: Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.
|
|
2733
|
+
protectionKind:
|
|
2734
|
+
allOf:
|
|
2735
|
+
- $ref: '#/components/schemas/ProtectionKind'
|
|
2736
|
+
- description: The type of protection for this Physical Link. Defaults to 'unknown'.
|
|
2737
|
+
latency:
|
|
2738
|
+
type: integer
|
|
2739
|
+
description: The latency of this Physical Link, if known, in units specified by the 'latencyUnits' field value. Defaults to 0.
|
|
2740
|
+
format: int64
|
|
2741
|
+
latencyUnits:
|
|
2742
|
+
allOf:
|
|
2743
|
+
- $ref: '#/components/schemas/LatencyUnits'
|
|
2744
|
+
- description: The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.
|
|
2745
|
+
restoration:
|
|
2746
|
+
allOf:
|
|
2747
|
+
- $ref: '#/components/schemas/Restoration'
|
|
2748
|
+
- description: The restoration type for this Physical Link. Defaults to 'unknown'.
|
|
2749
|
+
direction:
|
|
2750
|
+
allOf:
|
|
2751
|
+
- $ref: '#/components/schemas/Direction'
|
|
2752
|
+
- description: The direction of this Physical Link. Defaults to 'unknown'.
|
|
2753
|
+
adminState:
|
|
2754
|
+
allOf:
|
|
2755
|
+
- $ref: '#/components/schemas/AdminState4'
|
|
2756
|
+
- description: The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.
|
|
2757
|
+
operState:
|
|
2758
|
+
allOf:
|
|
2759
|
+
- $ref: '#/components/schemas/OperState4'
|
|
2760
|
+
- description: The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.
|
|
2761
|
+
standbyState:
|
|
2762
|
+
allOf:
|
|
2763
|
+
- $ref: '#/components/schemas/StandbyState4'
|
|
2764
|
+
- description: The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.
|
|
2765
|
+
availabilityStates:
|
|
2766
|
+
type: array
|
|
2767
|
+
items:
|
|
2768
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2769
|
+
description: The availability states of this Physical Link. Defaults to 'unknown', if present. Refer to the X.731 standard
|
|
2770
|
+
objectDetails:
|
|
2771
|
+
type: object
|
|
2772
|
+
additionalProperties:
|
|
2773
|
+
type: string
|
|
2774
|
+
description: Generic properties of this Physical Link, specific to the Network Supervision application.
|
|
2775
|
+
endpoints:
|
|
2776
|
+
type: array
|
|
2777
|
+
items:
|
|
2778
|
+
$ref: '#/components/schemas/PhysicalLinkEndpoint'
|
|
2779
|
+
description: The Endpoints associated to this Physical Link. Mandatory property for creation.
|
|
2780
|
+
PhysicalLinkEndpoint:
|
|
2781
|
+
title: PhysicalLinkEndpoint
|
|
2782
|
+
required:
|
|
2783
|
+
- type
|
|
2784
|
+
- port
|
|
2785
|
+
- lag
|
|
2786
|
+
- parentNe
|
|
2787
|
+
- parentNeId
|
|
2788
|
+
type: object
|
|
2789
|
+
properties:
|
|
2790
|
+
name:
|
|
2791
|
+
type: string
|
|
2792
|
+
description: The name of this Physical Link Endpoint. Defaults to null value.
|
|
2793
|
+
example: Port 1/1/1
|
|
2794
|
+
type:
|
|
2795
|
+
allOf:
|
|
2796
|
+
- $ref: '#/components/schemas/Type'
|
|
2797
|
+
- description: The type of this Physical Link Endpoint. Mandatory property for creation.
|
|
2798
|
+
example: physicalPort
|
|
2799
|
+
port:
|
|
2800
|
+
type: string
|
|
2801
|
+
description: The Fully Distinguished Name of the Port to use. Mandatory property for creation, if and only if 'type' value is 'physicalPort'.
|
|
2802
|
+
example: fdn:model:equipment:Equipment:2189
|
|
2803
|
+
lag:
|
|
2804
|
+
type: string
|
|
2805
|
+
description: The Fully Distinguished Name of the LAG to use. Mandatory property for creation, if and only if 'type' value is 'lag'.
|
|
2806
|
+
example: 'null'
|
|
2807
|
+
parentNe:
|
|
2808
|
+
type: string
|
|
2809
|
+
description: The Fully Distinguished Name of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.
|
|
2810
|
+
example: fdn:model:equipment:NetworkElement:2102
|
|
2811
|
+
parentNeId:
|
|
2812
|
+
type: string
|
|
2813
|
+
description: The identifier of the Network Element containing this Physical Link Endpoint. Mandatory property for creation.
|
|
2814
|
+
example: 38.120.169.111
|
|
2815
|
+
subnetName:
|
|
2816
|
+
type: string
|
|
2817
|
+
description: Will always be null, for the 'physicalPort', 'networkElement' and 'lag' types. Defaults to null value.
|
|
2818
|
+
example: 'null'
|
|
2819
|
+
objectDetails:
|
|
2820
|
+
type: object
|
|
2821
|
+
additionalProperties:
|
|
2822
|
+
type: string
|
|
2823
|
+
description: Generic properties of this Physical Link Endpoint, specific to the Network Supervision application.
|
|
2824
|
+
parentNeName:
|
|
2825
|
+
type: string
|
|
2826
|
+
description: The name of the Network Element containing this Physical Link Endpoint
|
|
2827
|
+
Port:
|
|
2828
|
+
title: Port
|
|
2829
|
+
required:
|
|
2830
|
+
- fdn
|
|
2831
|
+
- sourceType
|
|
2832
|
+
- sourceSystem
|
|
2833
|
+
- sources
|
|
2834
|
+
- name
|
|
2835
|
+
- neName
|
|
2836
|
+
- neId
|
|
2837
|
+
- positionId
|
|
2838
|
+
- position
|
|
2839
|
+
- adminState
|
|
2840
|
+
- operState
|
|
2841
|
+
- standbyState
|
|
2842
|
+
- availabilityStates
|
|
2843
|
+
type: object
|
|
2844
|
+
properties:
|
|
2845
|
+
links:
|
|
2846
|
+
type: array
|
|
2847
|
+
items:
|
|
2848
|
+
$ref: '#/components/schemas/Link'
|
|
2849
|
+
description: ''
|
|
2850
|
+
xml:
|
|
2851
|
+
namespace: http://www.w3.org/2005/Atom
|
|
2852
|
+
attribute: false
|
|
2853
|
+
wrapped: false
|
|
2854
|
+
fdn:
|
|
2855
|
+
type: string
|
|
2856
|
+
description: The Fully Distinguished Name of this Port.
|
|
2857
|
+
sourceType:
|
|
2858
|
+
allOf:
|
|
2859
|
+
- $ref: '#/components/schemas/SourceType5'
|
|
2860
|
+
- description: The type of the source system where this Port is sourced from.
|
|
2861
|
+
sourceSystem:
|
|
2862
|
+
type: string
|
|
2863
|
+
description: The source system where this Port is sourced from.
|
|
2864
|
+
sources:
|
|
2865
|
+
type: array
|
|
2866
|
+
items:
|
|
2867
|
+
type: string
|
|
2868
|
+
description: The Fully Distinguished Names of the Ports from the source system associated to this Port.
|
|
2869
|
+
name:
|
|
2870
|
+
type: string
|
|
2871
|
+
description: The name of this Port, as defined by the source system.
|
|
2872
|
+
neName:
|
|
2873
|
+
type: string
|
|
2874
|
+
description: The name of the Network Element containing this Port, as defined by the source system.
|
|
2875
|
+
neId:
|
|
2876
|
+
type: string
|
|
2877
|
+
description: The id of the Network Element containing this Port, as defined by the source system.
|
|
2878
|
+
description:
|
|
2879
|
+
type: string
|
|
2880
|
+
description: The detailed description of this Port.
|
|
2881
|
+
positionId:
|
|
2882
|
+
type: integer
|
|
2883
|
+
description: The relative position of the Port, that determines the order in which to show it in the source system UI.
|
|
2884
|
+
format: int64
|
|
2885
|
+
position:
|
|
2886
|
+
type: string
|
|
2887
|
+
description: A formatted name that describes the position of the Port within the Network Element.
|
|
2888
|
+
adminState:
|
|
2889
|
+
allOf:
|
|
2890
|
+
- $ref: '#/components/schemas/AdminState5'
|
|
2891
|
+
- description: The administrative state of this Port. Refer to the X.731 standard.
|
|
2892
|
+
operState:
|
|
2893
|
+
allOf:
|
|
2894
|
+
- $ref: '#/components/schemas/OperState5'
|
|
2895
|
+
- description: The operational state of this Port. Refer to the X.731 standard.
|
|
2896
|
+
standbyState:
|
|
2897
|
+
allOf:
|
|
2898
|
+
- $ref: '#/components/schemas/StandbyState5'
|
|
2899
|
+
- description: The standby state of this Port. Refer to the X.731 standard.
|
|
2900
|
+
availabilityStates:
|
|
2901
|
+
type: array
|
|
2902
|
+
items:
|
|
2903
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
2904
|
+
description: The availability states of this Port. Refer to the X.731 standard.
|
|
2905
|
+
stateReasons:
|
|
2906
|
+
type: array
|
|
2907
|
+
items:
|
|
2908
|
+
type: string
|
|
2909
|
+
description: A set of specific reasons why the Port is in this state.
|
|
2910
|
+
objectDetails:
|
|
2911
|
+
type: object
|
|
2912
|
+
additionalProperties:
|
|
2913
|
+
type: string
|
|
2914
|
+
description: Generic properties of this Port, specific to the Network Supervision application.
|
|
2915
|
+
manufacturer:
|
|
2916
|
+
type: string
|
|
2917
|
+
description: The vendor of the Port.
|
|
2918
|
+
serialNumber:
|
|
2919
|
+
type: string
|
|
2920
|
+
description: The serial number of the Port provided by the manufacturer.
|
|
2921
|
+
partNumber:
|
|
2922
|
+
type: string
|
|
2923
|
+
description: The part number of the Port provided by the manufacturer.
|
|
2924
|
+
manufacturerAssemblyNumber:
|
|
2925
|
+
type: string
|
|
2926
|
+
description: The assembly number of the Port provided by the manufacturer.
|
|
2927
|
+
manufactureDate:
|
|
2928
|
+
type: string
|
|
2929
|
+
description: The date of manufacture of the Port.
|
|
2930
|
+
manufacturingDeviations:
|
|
2931
|
+
type: string
|
|
2932
|
+
description: The manufacturing deviations of the Port provided by the manufacturer.
|
|
2933
|
+
macAddress:
|
|
2934
|
+
type: string
|
|
2935
|
+
description: The Configured MAC Address of the Port
|
|
2936
|
+
hwMacAddress:
|
|
2937
|
+
type: string
|
|
2938
|
+
description: The Hardware MAC Address of the Port
|
|
2939
|
+
portDetails:
|
|
2940
|
+
$ref: '#/components/schemas/PortDetails'
|
|
2941
|
+
lagDetails:
|
|
2942
|
+
$ref: '#/components/schemas/LAGMemberDetails'
|
|
2943
|
+
PortDetails:
|
|
2944
|
+
title: PortDetails
|
|
2945
|
+
required:
|
|
2946
|
+
- portMode
|
|
2947
|
+
type: object
|
|
2948
|
+
properties:
|
|
2949
|
+
fdn:
|
|
2950
|
+
type: string
|
|
2951
|
+
example: fdn:model:equipment:PortDetails:2209
|
|
2952
|
+
sourceType:
|
|
2953
|
+
allOf:
|
|
2954
|
+
- $ref: '#/components/schemas/SourceType1'
|
|
2955
|
+
- example: nfmp
|
|
2956
|
+
sourceSystem:
|
|
2957
|
+
type: string
|
|
2958
|
+
example: fdn:realm:sam
|
|
2959
|
+
sources:
|
|
2960
|
+
type: array
|
|
2961
|
+
items:
|
|
2962
|
+
type: string
|
|
2963
|
+
description: ''
|
|
2964
|
+
example:
|
|
2965
|
+
- fdn:realm:sam:network:38.120.169.111:shelf-1:cardSlot-2:card:port-1@portDetails
|
|
2966
|
+
objectDetails:
|
|
2967
|
+
type: object
|
|
2968
|
+
additionalProperties:
|
|
2969
|
+
type: string
|
|
2970
|
+
portIndex:
|
|
2971
|
+
type: integer
|
|
2972
|
+
description: The index of this Port. Generally, this is the SNMP 'ifIndex', if available.
|
|
2973
|
+
format: int64
|
|
2974
|
+
example: 67141632
|
|
2975
|
+
portType:
|
|
2976
|
+
allOf:
|
|
2977
|
+
- $ref: '#/components/schemas/PortType'
|
|
2978
|
+
- description: The type of this Port.
|
|
2979
|
+
example: ethernet
|
|
2980
|
+
rate:
|
|
2981
|
+
type: string
|
|
2982
|
+
description: The rate label of this Port.
|
|
2983
|
+
example: ethernet100
|
|
2984
|
+
actualRateUnits:
|
|
2985
|
+
allOf:
|
|
2986
|
+
- $ref: '#/components/schemas/ActualRateUnits1'
|
|
2987
|
+
- description: The units associated to the 'actualRate' field value for this Port.
|
|
2988
|
+
example: kbps
|
|
2989
|
+
actualRate:
|
|
2990
|
+
type: number
|
|
2991
|
+
description: The rate of this Port, in units specified by the 'actualRateUnits' field value.
|
|
2992
|
+
example: 100000
|
|
2993
|
+
portMode:
|
|
2994
|
+
allOf:
|
|
2995
|
+
- $ref: '#/components/schemas/PortMode'
|
|
2996
|
+
- description: The mode of port.
|
|
2997
|
+
example: access
|
|
2998
|
+
encapType:
|
|
2999
|
+
allOf:
|
|
3000
|
+
- $ref: '#/components/schemas/EncapType1'
|
|
3001
|
+
- description: The Encapsulation type of the port
|
|
3002
|
+
example: dot1q
|
|
3003
|
+
mtuValue:
|
|
3004
|
+
type: integer
|
|
3005
|
+
description: The MTU value of the port in bytes.
|
|
3006
|
+
format: int32
|
|
3007
|
+
example: 1578
|
|
3008
|
+
RadioEquipment:
|
|
3009
|
+
title: RadioEquipment
|
|
3010
|
+
type: object
|
|
3011
|
+
properties:
|
|
3012
|
+
adminState:
|
|
3013
|
+
type: string
|
|
3014
|
+
availabilityStates:
|
|
3015
|
+
type: array
|
|
3016
|
+
items:
|
|
3017
|
+
type: string
|
|
3018
|
+
description: ''
|
|
3019
|
+
chassisType:
|
|
3020
|
+
type: string
|
|
3021
|
+
clliCode:
|
|
3022
|
+
type: string
|
|
3023
|
+
communicationState:
|
|
3024
|
+
type: string
|
|
3025
|
+
description:
|
|
3026
|
+
type: string
|
|
3027
|
+
fdn:
|
|
3028
|
+
type: string
|
|
3029
|
+
ipAddress:
|
|
3030
|
+
type: string
|
|
3031
|
+
latitude:
|
|
3032
|
+
type: number
|
|
3033
|
+
links:
|
|
3034
|
+
type: array
|
|
3035
|
+
items:
|
|
3036
|
+
$ref: '#/components/schemas/Link'
|
|
3037
|
+
description: ''
|
|
3038
|
+
xml:
|
|
3039
|
+
namespace: http://www.w3.org/2005/Atom
|
|
3040
|
+
attribute: false
|
|
3041
|
+
wrapped: false
|
|
3042
|
+
location:
|
|
3043
|
+
type: string
|
|
3044
|
+
longitude:
|
|
3045
|
+
type: number
|
|
3046
|
+
macAddress:
|
|
3047
|
+
type: string
|
|
3048
|
+
managedState:
|
|
3049
|
+
type: string
|
|
3050
|
+
name:
|
|
3051
|
+
type: string
|
|
3052
|
+
neId:
|
|
3053
|
+
type: string
|
|
3054
|
+
neName:
|
|
3055
|
+
type: string
|
|
3056
|
+
objectDetails:
|
|
3057
|
+
type: object
|
|
3058
|
+
additionalProperties:
|
|
3059
|
+
type: string
|
|
3060
|
+
operState:
|
|
3061
|
+
type: string
|
|
3062
|
+
parentNeName:
|
|
3063
|
+
type: string
|
|
3064
|
+
product:
|
|
3065
|
+
type: string
|
|
3066
|
+
resyncState:
|
|
3067
|
+
type: string
|
|
3068
|
+
sourceSystem:
|
|
3069
|
+
type: string
|
|
3070
|
+
sourceType:
|
|
3071
|
+
type: string
|
|
3072
|
+
sources:
|
|
3073
|
+
type: array
|
|
3074
|
+
items:
|
|
3075
|
+
type: string
|
|
3076
|
+
description: ''
|
|
3077
|
+
standbyState:
|
|
3078
|
+
type: string
|
|
3079
|
+
systemAddress:
|
|
3080
|
+
type: string
|
|
3081
|
+
version:
|
|
3082
|
+
type: string
|
|
3083
|
+
ReachabilityStatus:
|
|
3084
|
+
title: ReachabilityStatus
|
|
3085
|
+
type: object
|
|
3086
|
+
properties:
|
|
3087
|
+
address:
|
|
3088
|
+
type: string
|
|
3089
|
+
lastAttempt:
|
|
3090
|
+
type: integer
|
|
3091
|
+
format: int64
|
|
3092
|
+
protocol:
|
|
3093
|
+
type: string
|
|
3094
|
+
state:
|
|
3095
|
+
type: string
|
|
3096
|
+
ResponseDataCardSlot:
|
|
3097
|
+
title: ResponseDataCardSlot
|
|
3098
|
+
type: object
|
|
3099
|
+
properties:
|
|
3100
|
+
response:
|
|
3101
|
+
$ref: '#/components/schemas/ResponseCardSlot'
|
|
3102
|
+
ResponseDataCard:
|
|
3103
|
+
title: ResponseDataCard
|
|
3104
|
+
type: object
|
|
3105
|
+
properties:
|
|
3106
|
+
response:
|
|
3107
|
+
$ref: '#/components/schemas/ResponseCard'
|
|
3108
|
+
ResponseDataLAG:
|
|
3109
|
+
title: ResponseDataLAG
|
|
3110
|
+
type: object
|
|
3111
|
+
properties:
|
|
3112
|
+
response:
|
|
3113
|
+
$ref: '#/components/schemas/ResponseLAG'
|
|
3114
|
+
ResponseDataListCardSlot:
|
|
3115
|
+
title: ResponseDataListCardSlot
|
|
3116
|
+
type: object
|
|
3117
|
+
properties:
|
|
3118
|
+
response:
|
|
3119
|
+
$ref: '#/components/schemas/ResponseListCardSlot'
|
|
3120
|
+
ResponseDataListCard:
|
|
3121
|
+
title: ResponseDataListCard
|
|
3122
|
+
type: object
|
|
3123
|
+
properties:
|
|
3124
|
+
response:
|
|
3125
|
+
$ref: '#/components/schemas/ResponseListCard'
|
|
3126
|
+
ResponseDataListLAGMemberDetails:
|
|
3127
|
+
title: ResponseDataListLAGMemberDetails
|
|
3128
|
+
type: object
|
|
3129
|
+
properties:
|
|
3130
|
+
response:
|
|
3131
|
+
$ref: '#/components/schemas/ResponseListLAGMemberDetails'
|
|
3132
|
+
ResponseDataListLAG:
|
|
3133
|
+
title: ResponseDataListLAG
|
|
3134
|
+
type: object
|
|
3135
|
+
properties:
|
|
3136
|
+
response:
|
|
3137
|
+
$ref: '#/components/schemas/ResponseListLAG'
|
|
3138
|
+
ResponseDataListNetworkElement:
|
|
3139
|
+
title: ResponseDataListNetworkElement
|
|
3140
|
+
type: object
|
|
3141
|
+
properties:
|
|
3142
|
+
response:
|
|
3143
|
+
$ref: '#/components/schemas/ResponseListNetworkElement'
|
|
3144
|
+
ResponseDataListPhysicalLink:
|
|
3145
|
+
title: ResponseDataListPhysicalLink
|
|
3146
|
+
type: object
|
|
3147
|
+
properties:
|
|
3148
|
+
response:
|
|
3149
|
+
$ref: '#/components/schemas/ResponseListPhysicalLink'
|
|
3150
|
+
ResponseDataListPort:
|
|
3151
|
+
title: ResponseDataListPort
|
|
3152
|
+
type: object
|
|
3153
|
+
properties:
|
|
3154
|
+
response:
|
|
3155
|
+
$ref: '#/components/schemas/ResponseListPort'
|
|
3156
|
+
ResponseDataListRadioEquipment:
|
|
3157
|
+
title: ResponseDataListRadioEquipment
|
|
3158
|
+
type: object
|
|
3159
|
+
properties:
|
|
3160
|
+
response:
|
|
3161
|
+
$ref: '#/components/schemas/ResponseListRadioEquipment'
|
|
3162
|
+
ResponseDataListShelf:
|
|
3163
|
+
title: ResponseDataListShelf
|
|
3164
|
+
type: object
|
|
3165
|
+
properties:
|
|
3166
|
+
response:
|
|
3167
|
+
$ref: '#/components/schemas/ResponseListShelf'
|
|
3168
|
+
ResponseDataNetworkElement:
|
|
3169
|
+
title: ResponseDataNetworkElement
|
|
3170
|
+
type: object
|
|
3171
|
+
properties:
|
|
3172
|
+
response:
|
|
3173
|
+
$ref: '#/components/schemas/ResponseNetworkElement'
|
|
3174
|
+
ResponseDataPhysicalLink:
|
|
3175
|
+
title: ResponseDataPhysicalLink
|
|
3176
|
+
type: object
|
|
3177
|
+
properties:
|
|
3178
|
+
response:
|
|
3179
|
+
$ref: '#/components/schemas/ResponsePhysicalLink'
|
|
3180
|
+
ResponseDataPort:
|
|
3181
|
+
title: ResponseDataPort
|
|
3182
|
+
type: object
|
|
3183
|
+
properties:
|
|
3184
|
+
response:
|
|
3185
|
+
$ref: '#/components/schemas/ResponsePort'
|
|
3186
|
+
ResponseDataRadioEquipment:
|
|
3187
|
+
title: ResponseDataRadioEquipment
|
|
3188
|
+
type: object
|
|
3189
|
+
properties:
|
|
3190
|
+
response:
|
|
3191
|
+
$ref: '#/components/schemas/ResponseRadioEquipment'
|
|
3192
|
+
ResponseDataShelf:
|
|
3193
|
+
title: ResponseDataShelf
|
|
3194
|
+
type: object
|
|
3195
|
+
properties:
|
|
3196
|
+
response:
|
|
3197
|
+
$ref: '#/components/schemas/ResponseShelf'
|
|
3198
|
+
ResponseCardSlot:
|
|
3199
|
+
title: ResponseCardSlot
|
|
3200
|
+
type: object
|
|
3201
|
+
properties:
|
|
3202
|
+
data:
|
|
3203
|
+
$ref: '#/components/schemas/CardSlot'
|
|
3204
|
+
endRow:
|
|
3205
|
+
type: integer
|
|
3206
|
+
format: int64
|
|
3207
|
+
errors:
|
|
3208
|
+
type: array
|
|
3209
|
+
items:
|
|
3210
|
+
type: object
|
|
3211
|
+
description: ''
|
|
3212
|
+
nextPage:
|
|
3213
|
+
type: string
|
|
3214
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3215
|
+
previousPage:
|
|
3216
|
+
type: string
|
|
3217
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3218
|
+
startRow:
|
|
3219
|
+
type: integer
|
|
3220
|
+
format: int64
|
|
3221
|
+
status:
|
|
3222
|
+
type: integer
|
|
3223
|
+
format: int32
|
|
3224
|
+
totalRows:
|
|
3225
|
+
type: integer
|
|
3226
|
+
format: int64
|
|
3227
|
+
ResponseCard:
|
|
3228
|
+
title: ResponseCard
|
|
3229
|
+
type: object
|
|
3230
|
+
properties:
|
|
3231
|
+
data:
|
|
3232
|
+
$ref: '#/components/schemas/Card'
|
|
3233
|
+
endRow:
|
|
3234
|
+
type: integer
|
|
3235
|
+
format: int64
|
|
3236
|
+
errors:
|
|
3237
|
+
type: array
|
|
3238
|
+
items:
|
|
3239
|
+
type: object
|
|
3240
|
+
description: ''
|
|
3241
|
+
nextPage:
|
|
3242
|
+
type: string
|
|
3243
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3244
|
+
previousPage:
|
|
3245
|
+
type: string
|
|
3246
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3247
|
+
startRow:
|
|
3248
|
+
type: integer
|
|
3249
|
+
format: int64
|
|
3250
|
+
status:
|
|
3251
|
+
type: integer
|
|
3252
|
+
format: int32
|
|
3253
|
+
totalRows:
|
|
3254
|
+
type: integer
|
|
3255
|
+
format: int64
|
|
3256
|
+
ResponseLAG:
|
|
3257
|
+
title: ResponseLAG
|
|
3258
|
+
type: object
|
|
3259
|
+
properties:
|
|
3260
|
+
data:
|
|
3261
|
+
$ref: '#/components/schemas/LAG'
|
|
3262
|
+
endRow:
|
|
3263
|
+
type: integer
|
|
3264
|
+
format: int64
|
|
3265
|
+
errors:
|
|
3266
|
+
type: array
|
|
3267
|
+
items:
|
|
3268
|
+
type: object
|
|
3269
|
+
description: ''
|
|
3270
|
+
nextPage:
|
|
3271
|
+
type: string
|
|
3272
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3273
|
+
previousPage:
|
|
3274
|
+
type: string
|
|
3275
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3276
|
+
startRow:
|
|
3277
|
+
type: integer
|
|
3278
|
+
format: int64
|
|
3279
|
+
status:
|
|
3280
|
+
type: integer
|
|
3281
|
+
format: int32
|
|
3282
|
+
totalRows:
|
|
3283
|
+
type: integer
|
|
3284
|
+
format: int64
|
|
3285
|
+
ResponseListCardSlot:
|
|
3286
|
+
title: ResponseListCardSlot
|
|
3287
|
+
type: object
|
|
3288
|
+
properties:
|
|
3289
|
+
data:
|
|
3290
|
+
type: array
|
|
3291
|
+
items:
|
|
3292
|
+
$ref: '#/components/schemas/CardSlot'
|
|
3293
|
+
description: ''
|
|
3294
|
+
endRow:
|
|
3295
|
+
type: integer
|
|
3296
|
+
format: int64
|
|
3297
|
+
errors:
|
|
3298
|
+
type: array
|
|
3299
|
+
items:
|
|
3300
|
+
type: object
|
|
3301
|
+
description: ''
|
|
3302
|
+
nextPage:
|
|
3303
|
+
type: string
|
|
3304
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3305
|
+
previousPage:
|
|
3306
|
+
type: string
|
|
3307
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3308
|
+
startRow:
|
|
3309
|
+
type: integer
|
|
3310
|
+
format: int64
|
|
3311
|
+
status:
|
|
3312
|
+
type: integer
|
|
3313
|
+
format: int32
|
|
3314
|
+
totalRows:
|
|
3315
|
+
type: integer
|
|
3316
|
+
format: int64
|
|
3317
|
+
ResponseListCard:
|
|
3318
|
+
title: ResponseListCard
|
|
3319
|
+
type: object
|
|
3320
|
+
properties:
|
|
3321
|
+
data:
|
|
3322
|
+
type: array
|
|
3323
|
+
items:
|
|
3324
|
+
$ref: '#/components/schemas/Card'
|
|
3325
|
+
description: ''
|
|
3326
|
+
endRow:
|
|
3327
|
+
type: integer
|
|
3328
|
+
format: int64
|
|
3329
|
+
errors:
|
|
3330
|
+
type: array
|
|
3331
|
+
items:
|
|
3332
|
+
type: object
|
|
3333
|
+
description: ''
|
|
3334
|
+
nextPage:
|
|
3335
|
+
type: string
|
|
3336
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3337
|
+
previousPage:
|
|
3338
|
+
type: string
|
|
3339
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3340
|
+
startRow:
|
|
3341
|
+
type: integer
|
|
3342
|
+
format: int64
|
|
3343
|
+
status:
|
|
3344
|
+
type: integer
|
|
3345
|
+
format: int32
|
|
3346
|
+
totalRows:
|
|
3347
|
+
type: integer
|
|
3348
|
+
format: int64
|
|
3349
|
+
ResponseListLAGMemberDetails:
|
|
3350
|
+
title: ResponseListLAGMemberDetails
|
|
3351
|
+
type: object
|
|
3352
|
+
properties:
|
|
3353
|
+
data:
|
|
3354
|
+
type: array
|
|
3355
|
+
items:
|
|
3356
|
+
$ref: '#/components/schemas/LAGMemberDetails'
|
|
3357
|
+
description: ''
|
|
3358
|
+
endRow:
|
|
3359
|
+
type: integer
|
|
3360
|
+
format: int64
|
|
3361
|
+
errors:
|
|
3362
|
+
type: array
|
|
3363
|
+
items:
|
|
3364
|
+
type: object
|
|
3365
|
+
description: ''
|
|
3366
|
+
nextPage:
|
|
3367
|
+
type: string
|
|
3368
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3369
|
+
previousPage:
|
|
3370
|
+
type: string
|
|
3371
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3372
|
+
startRow:
|
|
3373
|
+
type: integer
|
|
3374
|
+
format: int64
|
|
3375
|
+
status:
|
|
3376
|
+
type: integer
|
|
3377
|
+
format: int32
|
|
3378
|
+
totalRows:
|
|
3379
|
+
type: integer
|
|
3380
|
+
format: int64
|
|
3381
|
+
ResponseListLAG:
|
|
3382
|
+
title: ResponseListLAG
|
|
3383
|
+
type: object
|
|
3384
|
+
properties:
|
|
3385
|
+
data:
|
|
3386
|
+
type: array
|
|
3387
|
+
items:
|
|
3388
|
+
$ref: '#/components/schemas/LAG'
|
|
3389
|
+
description: ''
|
|
3390
|
+
endRow:
|
|
3391
|
+
type: integer
|
|
3392
|
+
format: int64
|
|
3393
|
+
errors:
|
|
3394
|
+
type: array
|
|
3395
|
+
items:
|
|
3396
|
+
type: object
|
|
3397
|
+
description: ''
|
|
3398
|
+
nextPage:
|
|
3399
|
+
type: string
|
|
3400
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3401
|
+
previousPage:
|
|
3402
|
+
type: string
|
|
3403
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3404
|
+
startRow:
|
|
3405
|
+
type: integer
|
|
3406
|
+
format: int64
|
|
3407
|
+
status:
|
|
3408
|
+
type: integer
|
|
3409
|
+
format: int32
|
|
3410
|
+
totalRows:
|
|
3411
|
+
type: integer
|
|
3412
|
+
format: int64
|
|
3413
|
+
ResponseListNetworkElement:
|
|
3414
|
+
title: ResponseListNetworkElement
|
|
3415
|
+
type: object
|
|
3416
|
+
properties:
|
|
3417
|
+
data:
|
|
3418
|
+
type: array
|
|
3419
|
+
items:
|
|
3420
|
+
$ref: '#/components/schemas/NetworkElement'
|
|
3421
|
+
description: ''
|
|
3422
|
+
endRow:
|
|
3423
|
+
type: integer
|
|
3424
|
+
format: int64
|
|
3425
|
+
errors:
|
|
3426
|
+
type: array
|
|
3427
|
+
items:
|
|
3428
|
+
type: object
|
|
3429
|
+
description: ''
|
|
3430
|
+
nextPage:
|
|
3431
|
+
type: string
|
|
3432
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3433
|
+
previousPage:
|
|
3434
|
+
type: string
|
|
3435
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3436
|
+
startRow:
|
|
3437
|
+
type: integer
|
|
3438
|
+
format: int64
|
|
3439
|
+
status:
|
|
3440
|
+
type: integer
|
|
3441
|
+
format: int32
|
|
3442
|
+
totalRows:
|
|
3443
|
+
type: integer
|
|
3444
|
+
format: int64
|
|
3445
|
+
ResponseListPhysicalLink:
|
|
3446
|
+
title: ResponseListPhysicalLink
|
|
3447
|
+
type: object
|
|
3448
|
+
properties:
|
|
3449
|
+
data:
|
|
3450
|
+
type: array
|
|
3451
|
+
items:
|
|
3452
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
3453
|
+
description: ''
|
|
3454
|
+
endRow:
|
|
3455
|
+
type: integer
|
|
3456
|
+
format: int64
|
|
3457
|
+
errors:
|
|
3458
|
+
type: array
|
|
3459
|
+
items:
|
|
3460
|
+
type: object
|
|
3461
|
+
description: ''
|
|
3462
|
+
nextPage:
|
|
3463
|
+
type: string
|
|
3464
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3465
|
+
previousPage:
|
|
3466
|
+
type: string
|
|
3467
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3468
|
+
startRow:
|
|
3469
|
+
type: integer
|
|
3470
|
+
format: int64
|
|
3471
|
+
status:
|
|
3472
|
+
type: integer
|
|
3473
|
+
format: int32
|
|
3474
|
+
totalRows:
|
|
3475
|
+
type: integer
|
|
3476
|
+
format: int64
|
|
3477
|
+
ResponseListPort:
|
|
3478
|
+
title: ResponseListPort
|
|
3479
|
+
type: object
|
|
3480
|
+
properties:
|
|
3481
|
+
data:
|
|
3482
|
+
type: array
|
|
3483
|
+
items:
|
|
3484
|
+
$ref: '#/components/schemas/Port'
|
|
3485
|
+
description: ''
|
|
3486
|
+
endRow:
|
|
3487
|
+
type: integer
|
|
3488
|
+
format: int64
|
|
3489
|
+
errors:
|
|
3490
|
+
type: array
|
|
3491
|
+
items:
|
|
3492
|
+
type: object
|
|
3493
|
+
description: ''
|
|
3494
|
+
nextPage:
|
|
3495
|
+
type: string
|
|
3496
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3497
|
+
previousPage:
|
|
3498
|
+
type: string
|
|
3499
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3500
|
+
startRow:
|
|
3501
|
+
type: integer
|
|
3502
|
+
format: int64
|
|
3503
|
+
status:
|
|
3504
|
+
type: integer
|
|
3505
|
+
format: int32
|
|
3506
|
+
totalRows:
|
|
3507
|
+
type: integer
|
|
3508
|
+
format: int64
|
|
3509
|
+
ResponseListRadioEquipment:
|
|
3510
|
+
title: ResponseListRadioEquipment
|
|
3511
|
+
type: object
|
|
3512
|
+
properties:
|
|
3513
|
+
data:
|
|
3514
|
+
type: array
|
|
3515
|
+
items:
|
|
3516
|
+
$ref: '#/components/schemas/RadioEquipment'
|
|
3517
|
+
description: ''
|
|
3518
|
+
endRow:
|
|
3519
|
+
type: integer
|
|
3520
|
+
format: int64
|
|
3521
|
+
errors:
|
|
3522
|
+
type: array
|
|
3523
|
+
items:
|
|
3524
|
+
type: object
|
|
3525
|
+
description: ''
|
|
3526
|
+
nextPage:
|
|
3527
|
+
type: string
|
|
3528
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3529
|
+
previousPage:
|
|
3530
|
+
type: string
|
|
3531
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3532
|
+
startRow:
|
|
3533
|
+
type: integer
|
|
3534
|
+
format: int64
|
|
3535
|
+
status:
|
|
3536
|
+
type: integer
|
|
3537
|
+
format: int32
|
|
3538
|
+
totalRows:
|
|
3539
|
+
type: integer
|
|
3540
|
+
format: int64
|
|
3541
|
+
ResponseListShelf:
|
|
3542
|
+
title: ResponseListShelf
|
|
3543
|
+
type: object
|
|
3544
|
+
properties:
|
|
3545
|
+
data:
|
|
3546
|
+
type: array
|
|
3547
|
+
items:
|
|
3548
|
+
$ref: '#/components/schemas/Shelf'
|
|
3549
|
+
description: ''
|
|
3550
|
+
endRow:
|
|
3551
|
+
type: integer
|
|
3552
|
+
format: int64
|
|
3553
|
+
errors:
|
|
3554
|
+
type: array
|
|
3555
|
+
items:
|
|
3556
|
+
type: object
|
|
3557
|
+
description: ''
|
|
3558
|
+
nextPage:
|
|
3559
|
+
type: string
|
|
3560
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3561
|
+
previousPage:
|
|
3562
|
+
type: string
|
|
3563
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3564
|
+
startRow:
|
|
3565
|
+
type: integer
|
|
3566
|
+
format: int64
|
|
3567
|
+
status:
|
|
3568
|
+
type: integer
|
|
3569
|
+
format: int32
|
|
3570
|
+
totalRows:
|
|
3571
|
+
type: integer
|
|
3572
|
+
format: int64
|
|
3573
|
+
ResponseNetworkElement:
|
|
3574
|
+
title: ResponseNetworkElement
|
|
3575
|
+
type: object
|
|
3576
|
+
properties:
|
|
3577
|
+
data:
|
|
3578
|
+
$ref: '#/components/schemas/NetworkElement'
|
|
3579
|
+
endRow:
|
|
3580
|
+
type: integer
|
|
3581
|
+
format: int64
|
|
3582
|
+
errors:
|
|
3583
|
+
type: array
|
|
3584
|
+
items:
|
|
3585
|
+
type: object
|
|
3586
|
+
description: ''
|
|
3587
|
+
nextPage:
|
|
3588
|
+
type: string
|
|
3589
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3590
|
+
previousPage:
|
|
3591
|
+
type: string
|
|
3592
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3593
|
+
startRow:
|
|
3594
|
+
type: integer
|
|
3595
|
+
format: int64
|
|
3596
|
+
status:
|
|
3597
|
+
type: integer
|
|
3598
|
+
format: int32
|
|
3599
|
+
totalRows:
|
|
3600
|
+
type: integer
|
|
3601
|
+
format: int64
|
|
3602
|
+
ResponsePhysicalLink:
|
|
3603
|
+
title: ResponsePhysicalLink
|
|
3604
|
+
type: object
|
|
3605
|
+
properties:
|
|
3606
|
+
data:
|
|
3607
|
+
$ref: '#/components/schemas/PhysicalLink'
|
|
3608
|
+
endRow:
|
|
3609
|
+
type: integer
|
|
3610
|
+
format: int64
|
|
3611
|
+
errors:
|
|
3612
|
+
type: array
|
|
3613
|
+
items:
|
|
3614
|
+
type: object
|
|
3615
|
+
description: ''
|
|
3616
|
+
nextPage:
|
|
3617
|
+
type: string
|
|
3618
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3619
|
+
previousPage:
|
|
3620
|
+
type: string
|
|
3621
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3622
|
+
startRow:
|
|
3623
|
+
type: integer
|
|
3624
|
+
format: int64
|
|
3625
|
+
status:
|
|
3626
|
+
type: integer
|
|
3627
|
+
format: int32
|
|
3628
|
+
totalRows:
|
|
3629
|
+
type: integer
|
|
3630
|
+
format: int64
|
|
3631
|
+
ResponsePort:
|
|
3632
|
+
title: ResponsePort
|
|
3633
|
+
type: object
|
|
3634
|
+
properties:
|
|
3635
|
+
data:
|
|
3636
|
+
$ref: '#/components/schemas/Port'
|
|
3637
|
+
endRow:
|
|
3638
|
+
type: integer
|
|
3639
|
+
format: int64
|
|
3640
|
+
errors:
|
|
3641
|
+
type: array
|
|
3642
|
+
items:
|
|
3643
|
+
type: object
|
|
3644
|
+
description: ''
|
|
3645
|
+
nextPage:
|
|
3646
|
+
type: string
|
|
3647
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3648
|
+
previousPage:
|
|
3649
|
+
type: string
|
|
3650
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3651
|
+
startRow:
|
|
3652
|
+
type: integer
|
|
3653
|
+
format: int64
|
|
3654
|
+
status:
|
|
3655
|
+
type: integer
|
|
3656
|
+
format: int32
|
|
3657
|
+
totalRows:
|
|
3658
|
+
type: integer
|
|
3659
|
+
format: int64
|
|
3660
|
+
ResponseRadioEquipment:
|
|
3661
|
+
title: ResponseRadioEquipment
|
|
3662
|
+
type: object
|
|
3663
|
+
properties:
|
|
3664
|
+
data:
|
|
3665
|
+
$ref: '#/components/schemas/RadioEquipment'
|
|
3666
|
+
endRow:
|
|
3667
|
+
type: integer
|
|
3668
|
+
format: int64
|
|
3669
|
+
errors:
|
|
3670
|
+
type: array
|
|
3671
|
+
items:
|
|
3672
|
+
type: object
|
|
3673
|
+
description: ''
|
|
3674
|
+
nextPage:
|
|
3675
|
+
type: string
|
|
3676
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3677
|
+
previousPage:
|
|
3678
|
+
type: string
|
|
3679
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3680
|
+
startRow:
|
|
3681
|
+
type: integer
|
|
3682
|
+
format: int64
|
|
3683
|
+
status:
|
|
3684
|
+
type: integer
|
|
3685
|
+
format: int32
|
|
3686
|
+
totalRows:
|
|
3687
|
+
type: integer
|
|
3688
|
+
format: int64
|
|
3689
|
+
ResponseShelf:
|
|
3690
|
+
title: ResponseShelf
|
|
3691
|
+
type: object
|
|
3692
|
+
properties:
|
|
3693
|
+
data:
|
|
3694
|
+
$ref: '#/components/schemas/Shelf'
|
|
3695
|
+
endRow:
|
|
3696
|
+
type: integer
|
|
3697
|
+
format: int64
|
|
3698
|
+
errors:
|
|
3699
|
+
type: array
|
|
3700
|
+
items:
|
|
3701
|
+
type: object
|
|
3702
|
+
description: ''
|
|
3703
|
+
nextPage:
|
|
3704
|
+
type: string
|
|
3705
|
+
description: (Optional) A paged URL request pointing to the next page of data, or "null" if there is no next page.
|
|
3706
|
+
previousPage:
|
|
3707
|
+
type: string
|
|
3708
|
+
description: (Optional) A paged URL request pointing to the previous page of data, or "null" if there is no previous page.
|
|
3709
|
+
startRow:
|
|
3710
|
+
type: integer
|
|
3711
|
+
format: int64
|
|
3712
|
+
status:
|
|
3713
|
+
type: integer
|
|
3714
|
+
format: int32
|
|
3715
|
+
totalRows:
|
|
3716
|
+
type: integer
|
|
3717
|
+
format: int64
|
|
3718
|
+
Shelf:
|
|
3719
|
+
title: Shelf
|
|
3720
|
+
required:
|
|
3721
|
+
- fdn
|
|
3722
|
+
- sourceType
|
|
3723
|
+
- sourceSystem
|
|
3724
|
+
- sources
|
|
3725
|
+
- name
|
|
3726
|
+
- neName
|
|
3727
|
+
- neId
|
|
3728
|
+
- positionId
|
|
3729
|
+
- position
|
|
3730
|
+
- adminState
|
|
3731
|
+
- operState
|
|
3732
|
+
- standbyState
|
|
3733
|
+
- availabilityStates
|
|
3734
|
+
type: object
|
|
3735
|
+
properties:
|
|
3736
|
+
links:
|
|
3737
|
+
type: array
|
|
3738
|
+
items:
|
|
3739
|
+
$ref: '#/components/schemas/Link'
|
|
3740
|
+
description: ''
|
|
3741
|
+
xml:
|
|
3742
|
+
namespace: http://www.w3.org/2005/Atom
|
|
3743
|
+
attribute: false
|
|
3744
|
+
wrapped: false
|
|
3745
|
+
fdn:
|
|
3746
|
+
type: string
|
|
3747
|
+
description: The Fully Distinguished Name of this Shelf.
|
|
3748
|
+
sourceType:
|
|
3749
|
+
allOf:
|
|
3750
|
+
- $ref: '#/components/schemas/SourceType7'
|
|
3751
|
+
- description: The type of the source system where this Shelf is sourced from.
|
|
3752
|
+
sourceSystem:
|
|
3753
|
+
type: string
|
|
3754
|
+
description: The source system where this Shelf is sourced from.
|
|
3755
|
+
sources:
|
|
3756
|
+
type: array
|
|
3757
|
+
items:
|
|
3758
|
+
type: string
|
|
3759
|
+
description: The Fully Distinguished Names of the Shelves from the source system associated to this Shelf.
|
|
3760
|
+
name:
|
|
3761
|
+
type: string
|
|
3762
|
+
description: The name of this Shelf, as defined by the source system.
|
|
3763
|
+
neName:
|
|
3764
|
+
type: string
|
|
3765
|
+
description: The name of the Network Element containing this Shelf, as defined by the source system.
|
|
3766
|
+
neId:
|
|
3767
|
+
type: string
|
|
3768
|
+
description: The id of the Network Element containing this Shelf, as defined by the source system.
|
|
3769
|
+
description:
|
|
3770
|
+
type: string
|
|
3771
|
+
description: The detailed description of this Shelf.
|
|
3772
|
+
positionId:
|
|
3773
|
+
type: integer
|
|
3774
|
+
description: The relative position of the Shelf, that determines the order in which to show it in the source system UI.
|
|
3775
|
+
format: int64
|
|
3776
|
+
position:
|
|
3777
|
+
type: string
|
|
3778
|
+
description: A formatted name that describes the position of the Shelf within the Network Element.
|
|
3779
|
+
adminState:
|
|
3780
|
+
allOf:
|
|
3781
|
+
- $ref: '#/components/schemas/AdminState6'
|
|
3782
|
+
- description: The administrative state of this Shelf. Refer to the X.731 standard.
|
|
3783
|
+
operState:
|
|
3784
|
+
allOf:
|
|
3785
|
+
- $ref: '#/components/schemas/OperState6'
|
|
3786
|
+
- description: The operational state of this Shelf. Refer to the X.731 standard.
|
|
3787
|
+
standbyState:
|
|
3788
|
+
allOf:
|
|
3789
|
+
- $ref: '#/components/schemas/StandbyState6'
|
|
3790
|
+
- description: The standby state of this Shelf. Refer to the X.731 standard.
|
|
3791
|
+
availabilityStates:
|
|
3792
|
+
type: array
|
|
3793
|
+
items:
|
|
3794
|
+
$ref: '#/components/schemas/AvailabilityState'
|
|
3795
|
+
description: The availability states of this Shelf. Refer to the X.731 standard.
|
|
3796
|
+
stateReasons:
|
|
3797
|
+
type: array
|
|
3798
|
+
items:
|
|
3799
|
+
type: string
|
|
3800
|
+
description: A set of specific reasons why the Shelf is in this state.
|
|
3801
|
+
objectDetails:
|
|
3802
|
+
type: object
|
|
3803
|
+
additionalProperties:
|
|
3804
|
+
type: string
|
|
3805
|
+
description: Generic properties of this Shelf, specific to the Network Supervision application.
|
|
3806
|
+
manufacturer:
|
|
3807
|
+
type: string
|
|
3808
|
+
description: The vendor of the Shelf.
|
|
3809
|
+
serialNumber:
|
|
3810
|
+
type: string
|
|
3811
|
+
description: The serial number of the Shelf provided by the manufacturer.
|
|
3812
|
+
partNumber:
|
|
3813
|
+
type: string
|
|
3814
|
+
description: The part number of the Shelf provided by the manufacturer.
|
|
3815
|
+
manufacturerAssemblyNumber:
|
|
3816
|
+
type: string
|
|
3817
|
+
description: The assembly number of the Shelf provided by the manufacturer.
|
|
3818
|
+
manufactureDate:
|
|
3819
|
+
type: string
|
|
3820
|
+
description: The date of manufacture of the Shelf.
|
|
3821
|
+
manufacturingDeviations:
|
|
3822
|
+
type: string
|
|
3823
|
+
description: The manufacturing deviations of the Shelf provided by the manufacturer.
|
|
3824
|
+
macAddress:
|
|
3825
|
+
type: string
|
|
3826
|
+
description: The Base MAC Address of the Shelf
|
|
3827
|
+
hwMacAddress:
|
|
3828
|
+
type: string
|
|
3829
|
+
description: The Hardware MAC Address of the Shelf
|
|
3830
|
+
ActualRateUnits:
|
|
3831
|
+
title: ActualRateUnits
|
|
3832
|
+
enum:
|
|
3833
|
+
- unknown
|
|
3834
|
+
- kbps
|
|
3835
|
+
- Mbps
|
|
3836
|
+
type: string
|
|
3837
|
+
description: The units associated to the 'actualRate' field value for this Physical Link. Default to 'unknown'.
|
|
3838
|
+
example: kbps
|
|
3839
|
+
ActualRateUnits1:
|
|
3840
|
+
title: ActualRateUnits1
|
|
3841
|
+
enum:
|
|
3842
|
+
- unknown
|
|
3843
|
+
- kbps
|
|
3844
|
+
- Mbps
|
|
3845
|
+
type: string
|
|
3846
|
+
description: The units associated to the 'actualRate' field value for this Port.
|
|
3847
|
+
example: kbps
|
|
3848
|
+
AdminState:
|
|
3849
|
+
title: AdminState
|
|
3850
|
+
enum:
|
|
3851
|
+
- unknown
|
|
3852
|
+
- unlocked
|
|
3853
|
+
- locked
|
|
3854
|
+
- forcedLockout
|
|
3855
|
+
- shuttingDown
|
|
3856
|
+
- maintenance
|
|
3857
|
+
type: string
|
|
3858
|
+
description: The administrative state of this Card. Refer to the X.731 standard.
|
|
3859
|
+
example: unlocked
|
|
3860
|
+
AdminState1:
|
|
3861
|
+
title: AdminState1
|
|
3862
|
+
enum:
|
|
3863
|
+
- unknown
|
|
3864
|
+
- unlocked
|
|
3865
|
+
- locked
|
|
3866
|
+
- forcedLockout
|
|
3867
|
+
- shuttingDown
|
|
3868
|
+
- maintenance
|
|
3869
|
+
type: string
|
|
3870
|
+
description: The administrative state of this Card Slot. Refer to the X.731 standard.
|
|
3871
|
+
example: unlocked
|
|
3872
|
+
AdminState2:
|
|
3873
|
+
title: AdminState2
|
|
3874
|
+
enum:
|
|
3875
|
+
- unknown
|
|
3876
|
+
- unlocked
|
|
3877
|
+
- locked
|
|
3878
|
+
- forcedLockout
|
|
3879
|
+
- shuttingDown
|
|
3880
|
+
- maintenance
|
|
3881
|
+
type: string
|
|
3882
|
+
description: The administrative state of this LAG. Refer to the X.731 standard.
|
|
3883
|
+
example: unlocked
|
|
3884
|
+
AdminState3:
|
|
3885
|
+
title: AdminState3
|
|
3886
|
+
enum:
|
|
3887
|
+
- unknown
|
|
3888
|
+
- unlocked
|
|
3889
|
+
- locked
|
|
3890
|
+
- forcedLockout
|
|
3891
|
+
- shuttingDown
|
|
3892
|
+
- maintenance
|
|
3893
|
+
type: string
|
|
3894
|
+
description: The administrative state of this Network Element. Refer to the X.731 standard.
|
|
3895
|
+
example: unlocked
|
|
3896
|
+
AdminState4:
|
|
3897
|
+
title: AdminState4
|
|
3898
|
+
enum:
|
|
3899
|
+
- unknown
|
|
3900
|
+
- unlocked
|
|
3901
|
+
- locked
|
|
3902
|
+
- forcedLockout
|
|
3903
|
+
- shuttingDown
|
|
3904
|
+
- maintenance
|
|
3905
|
+
type: string
|
|
3906
|
+
description: The adminstrative state of this Physical Link. Defaults to 'unknown'. Refer to the X.731 standard.
|
|
3907
|
+
example: unknown
|
|
3908
|
+
AdminState5:
|
|
3909
|
+
title: AdminState5
|
|
3910
|
+
enum:
|
|
3911
|
+
- unknown
|
|
3912
|
+
- unlocked
|
|
3913
|
+
- locked
|
|
3914
|
+
- forcedLockout
|
|
3915
|
+
- shuttingDown
|
|
3916
|
+
- maintenance
|
|
3917
|
+
type: string
|
|
3918
|
+
description: The administrative state of this Port. Refer to the X.731 standard.
|
|
3919
|
+
example: unlocked
|
|
3920
|
+
AdminState6:
|
|
3921
|
+
title: AdminState6
|
|
3922
|
+
enum:
|
|
3923
|
+
- unknown
|
|
3924
|
+
- unlocked
|
|
3925
|
+
- locked
|
|
3926
|
+
- forcedLockout
|
|
3927
|
+
- shuttingDown
|
|
3928
|
+
- maintenance
|
|
3929
|
+
type: string
|
|
3930
|
+
description: The administrative state of this Shelf. Refer to the X.731 standard.
|
|
3931
|
+
example: unlocked
|
|
3932
|
+
AvailabilityState:
|
|
3933
|
+
title: AvailabilityState
|
|
3934
|
+
enum:
|
|
3935
|
+
- unknown
|
|
3936
|
+
- inTest
|
|
3937
|
+
- failed
|
|
3938
|
+
- degraded
|
|
3939
|
+
- offLine
|
|
3940
|
+
- powerOff
|
|
3941
|
+
- offDuty
|
|
3942
|
+
- dependency
|
|
3943
|
+
- notInstalled
|
|
3944
|
+
- logFull
|
|
3945
|
+
type: string
|
|
3946
|
+
CommunicationState:
|
|
3947
|
+
title: CommunicationState
|
|
3948
|
+
enum:
|
|
3949
|
+
- unknown
|
|
3950
|
+
- up
|
|
3951
|
+
- down
|
|
3952
|
+
- partial
|
|
3953
|
+
type: string
|
|
3954
|
+
description: The communication status of this Network Element. Specifies if the management system can reach the Network Element, using one of its supported management protocols.
|
|
3955
|
+
example: up
|
|
3956
|
+
Direction:
|
|
3957
|
+
title: Direction
|
|
3958
|
+
enum:
|
|
3959
|
+
- unknown
|
|
3960
|
+
- uniDirectional
|
|
3961
|
+
- biDirectional
|
|
3962
|
+
type: string
|
|
3963
|
+
description: The direction of this Physical Link. Defaults to 'unknown'.
|
|
3964
|
+
example: uniDirectional
|
|
3965
|
+
EncapType:
|
|
3966
|
+
title: EncapType
|
|
3967
|
+
enum:
|
|
3968
|
+
- unknown
|
|
3969
|
+
- other
|
|
3970
|
+
- nullEncap
|
|
3971
|
+
- dot1q
|
|
3972
|
+
- qinq
|
|
3973
|
+
- mpls
|
|
3974
|
+
- bcpNull
|
|
3975
|
+
- bcpDot1q
|
|
3976
|
+
- ipcp
|
|
3977
|
+
- frameRelay
|
|
3978
|
+
- pppAuto
|
|
3979
|
+
- atm
|
|
3980
|
+
- wanMirror
|
|
3981
|
+
- ciscoHdlc
|
|
3982
|
+
- cem
|
|
3983
|
+
- rhdlc
|
|
3984
|
+
- raw
|
|
3985
|
+
- cellular
|
|
3986
|
+
- wlan
|
|
3987
|
+
type: string
|
|
3988
|
+
description: The encapsulation type of this LAG.
|
|
3989
|
+
example: nullEncap
|
|
3990
|
+
EncapType1:
|
|
3991
|
+
title: EncapType1
|
|
3992
|
+
enum:
|
|
3993
|
+
- unknown
|
|
3994
|
+
- other
|
|
3995
|
+
- nullEncap
|
|
3996
|
+
- dot1q
|
|
3997
|
+
- qinq
|
|
3998
|
+
- mpls
|
|
3999
|
+
- bcpNull
|
|
4000
|
+
- bcpDot1q
|
|
4001
|
+
- ipcp
|
|
4002
|
+
- frameRelay
|
|
4003
|
+
- pppAuto
|
|
4004
|
+
- atm
|
|
4005
|
+
- wanMirror
|
|
4006
|
+
- ciscoHdlc
|
|
4007
|
+
- cem
|
|
4008
|
+
- rhdlc
|
|
4009
|
+
- raw
|
|
4010
|
+
- cellular
|
|
4011
|
+
- wlan
|
|
4012
|
+
type: string
|
|
4013
|
+
description: The Encapsulation type of the port
|
|
4014
|
+
example: dot1q
|
|
4015
|
+
LagMode:
|
|
4016
|
+
title: LagMode
|
|
4017
|
+
enum:
|
|
4018
|
+
- undefined
|
|
4019
|
+
- access
|
|
4020
|
+
- trunk
|
|
4021
|
+
- hybrid
|
|
4022
|
+
type: string
|
|
4023
|
+
description: The mode of this LAG.
|
|
4024
|
+
example: access
|
|
4025
|
+
LatencyUnits:
|
|
4026
|
+
title: LatencyUnits
|
|
4027
|
+
enum:
|
|
4028
|
+
- unknown
|
|
4029
|
+
- nanoseconds
|
|
4030
|
+
- microseconds
|
|
4031
|
+
- milliseconds
|
|
4032
|
+
- seconds
|
|
4033
|
+
- minutes
|
|
4034
|
+
- hours
|
|
4035
|
+
- days
|
|
4036
|
+
type: string
|
|
4037
|
+
description: The units associated to the 'latency' field value for this Physical Link. Default to 'unknown'.
|
|
4038
|
+
example: nanoseconds
|
|
4039
|
+
ManagedState:
|
|
4040
|
+
title: ManagedState
|
|
4041
|
+
enum:
|
|
4042
|
+
- unknown
|
|
4043
|
+
- managed
|
|
4044
|
+
- preprovisioned
|
|
4045
|
+
- suspended
|
|
4046
|
+
- failed
|
|
4047
|
+
type: string
|
|
4048
|
+
description: The management state of this Network Element.
|
|
4049
|
+
example: managed
|
|
4050
|
+
NetworkType:
|
|
4051
|
+
title: NetworkType
|
|
4052
|
+
enum:
|
|
4053
|
+
- ext
|
|
4054
|
+
- unknown
|
|
4055
|
+
- ip
|
|
4056
|
+
- optical
|
|
4057
|
+
- wireless
|
|
4058
|
+
type: string
|
|
4059
|
+
description: The type of network this Network Element is part of.
|
|
4060
|
+
example: ip
|
|
4061
|
+
OperState:
|
|
4062
|
+
title: OperState
|
|
4063
|
+
enum:
|
|
4064
|
+
- unknown
|
|
4065
|
+
- enabled
|
|
4066
|
+
- disabled
|
|
4067
|
+
type: string
|
|
4068
|
+
description: The operational state of this Card. Refer to the X.731 standard.
|
|
4069
|
+
example: enabled
|
|
4070
|
+
OperState1:
|
|
4071
|
+
title: OperState1
|
|
4072
|
+
enum:
|
|
4073
|
+
- unknown
|
|
4074
|
+
- enabled
|
|
4075
|
+
- disabled
|
|
4076
|
+
type: string
|
|
4077
|
+
description: The operational state of this Card Slot. Refer to the X.731 standard.
|
|
4078
|
+
example: enabled
|
|
4079
|
+
OperState2:
|
|
4080
|
+
title: OperState2
|
|
4081
|
+
enum:
|
|
4082
|
+
- unknown
|
|
4083
|
+
- enabled
|
|
4084
|
+
- disabled
|
|
4085
|
+
type: string
|
|
4086
|
+
description: The operational state of this LAG. Refer to the X.731 standard.
|
|
4087
|
+
example: enabled
|
|
4088
|
+
OperState3:
|
|
4089
|
+
title: OperState3
|
|
4090
|
+
enum:
|
|
4091
|
+
- unknown
|
|
4092
|
+
- enabled
|
|
4093
|
+
- disabled
|
|
4094
|
+
type: string
|
|
4095
|
+
description: The operational state of this Network Element. Refer to the X.731 standard.
|
|
4096
|
+
example: enabled
|
|
4097
|
+
OperState4:
|
|
4098
|
+
title: OperState4
|
|
4099
|
+
enum:
|
|
4100
|
+
- unknown
|
|
4101
|
+
- enabled
|
|
4102
|
+
- disabled
|
|
4103
|
+
type: string
|
|
4104
|
+
description: The operational state of this Physical Link. Read only. Defaults to 'unknown'. Refer to the X.731 standard.
|
|
4105
|
+
OperState5:
|
|
4106
|
+
title: OperState5
|
|
4107
|
+
enum:
|
|
4108
|
+
- unknown
|
|
4109
|
+
- enabled
|
|
4110
|
+
- disabled
|
|
4111
|
+
type: string
|
|
4112
|
+
description: The operational state of this Port. Refer to the X.731 standard.
|
|
4113
|
+
example: enabled
|
|
4114
|
+
OperState6:
|
|
4115
|
+
title: OperState6
|
|
4116
|
+
enum:
|
|
4117
|
+
- unknown
|
|
4118
|
+
- enabled
|
|
4119
|
+
- disabled
|
|
4120
|
+
type: string
|
|
4121
|
+
description: The operational state of this Shelf. Refer to the X.731 standard.
|
|
4122
|
+
example: enabled
|
|
4123
|
+
PortMode:
|
|
4124
|
+
title: PortMode
|
|
4125
|
+
enum:
|
|
4126
|
+
- undefined
|
|
4127
|
+
- access
|
|
4128
|
+
- trunk
|
|
4129
|
+
- hybrid
|
|
4130
|
+
type: string
|
|
4131
|
+
description: The mode of port.
|
|
4132
|
+
example: access
|
|
4133
|
+
PortType:
|
|
4134
|
+
title: PortType
|
|
4135
|
+
enum:
|
|
4136
|
+
- ext
|
|
4137
|
+
- unknown
|
|
4138
|
+
- none
|
|
4139
|
+
- other
|
|
4140
|
+
- ethernet
|
|
4141
|
+
- sonet
|
|
4142
|
+
- virtual
|
|
4143
|
+
- sonetChannel
|
|
4144
|
+
- tdm
|
|
4145
|
+
- radio
|
|
4146
|
+
- wireless
|
|
4147
|
+
- serial
|
|
4148
|
+
- voice
|
|
4149
|
+
- wdm
|
|
4150
|
+
- gpon
|
|
4151
|
+
- dsl
|
|
4152
|
+
- otu
|
|
4153
|
+
- sdh
|
|
4154
|
+
- connector
|
|
4155
|
+
- coherentOptical
|
|
4156
|
+
- otClient
|
|
4157
|
+
- otLine
|
|
4158
|
+
type: string
|
|
4159
|
+
description: The type of this Port.
|
|
4160
|
+
example: ethernet
|
|
4161
|
+
Protection:
|
|
4162
|
+
title: Protection
|
|
4163
|
+
enum:
|
|
4164
|
+
- unknown
|
|
4165
|
+
- Unprotected
|
|
4166
|
+
- Protected
|
|
4167
|
+
type: string
|
|
4168
|
+
description: Indicates if this Physical Link is protected or unprotected. Defaults to 'unknown'.
|
|
4169
|
+
example: Protected
|
|
4170
|
+
ProtectionKind:
|
|
4171
|
+
title: ProtectionKind
|
|
4172
|
+
enum:
|
|
4173
|
+
- unknown
|
|
4174
|
+
- oneToOne
|
|
4175
|
+
- oneToMany
|
|
4176
|
+
- opsaProtected
|
|
4177
|
+
- opsbProtected
|
|
4178
|
+
- yCableProtected
|
|
4179
|
+
- esncpSncI
|
|
4180
|
+
- esncpSncN
|
|
4181
|
+
- esncpSncS
|
|
4182
|
+
- omsp
|
|
4183
|
+
- olp
|
|
4184
|
+
type: string
|
|
4185
|
+
description: The type of protection for this Physical Link. Defaults to 'unknown'.
|
|
4186
|
+
example: unknown
|
|
4187
|
+
Restoration:
|
|
4188
|
+
title: Restoration
|
|
4189
|
+
enum:
|
|
4190
|
+
- unknown
|
|
4191
|
+
- none
|
|
4192
|
+
- sourceBased
|
|
4193
|
+
- guaranteed
|
|
4194
|
+
type: string
|
|
4195
|
+
description: The restoration type for this Physical Link. Defaults to 'unknown'.
|
|
4196
|
+
example: unknown
|
|
4197
|
+
ResyncState:
|
|
4198
|
+
title: ResyncState
|
|
4199
|
+
enum:
|
|
4200
|
+
- unknown
|
|
4201
|
+
- inProgress
|
|
4202
|
+
- done
|
|
4203
|
+
- failed
|
|
4204
|
+
- requested
|
|
4205
|
+
- notAttempted
|
|
4206
|
+
type: string
|
|
4207
|
+
description: The resynchronization status of this Network Element.
|
|
4208
|
+
example: done
|
|
4209
|
+
SourceType:
|
|
4210
|
+
title: SourceType
|
|
4211
|
+
enum:
|
|
4212
|
+
- other
|
|
4213
|
+
- nsd
|
|
4214
|
+
- nfmp
|
|
4215
|
+
- nfmt
|
|
4216
|
+
- nrcp
|
|
4217
|
+
- nrct
|
|
4218
|
+
- nrcf
|
|
4219
|
+
- nrcx
|
|
4220
|
+
- mdm
|
|
4221
|
+
- nsp
|
|
4222
|
+
type: string
|
|
4223
|
+
description: The type of the source system where this Card is sourced from.
|
|
4224
|
+
example: nfmp
|
|
4225
|
+
SourceType1:
|
|
4226
|
+
title: SourceType1
|
|
4227
|
+
enum:
|
|
4228
|
+
- other
|
|
4229
|
+
- nsd
|
|
4230
|
+
- nfmp
|
|
4231
|
+
- nfmt
|
|
4232
|
+
- nrcp
|
|
4233
|
+
- nrct
|
|
4234
|
+
- nrcf
|
|
4235
|
+
- nrcx
|
|
4236
|
+
- mdm
|
|
4237
|
+
- nsp
|
|
4238
|
+
type: string
|
|
4239
|
+
example: nfmp
|
|
4240
|
+
SourceType2:
|
|
4241
|
+
title: SourceType2
|
|
4242
|
+
enum:
|
|
4243
|
+
- other
|
|
4244
|
+
- nsd
|
|
4245
|
+
- nfmp
|
|
4246
|
+
- nfmt
|
|
4247
|
+
- nrcp
|
|
4248
|
+
- nrct
|
|
4249
|
+
- nrcf
|
|
4250
|
+
- nrcx
|
|
4251
|
+
- mdm
|
|
4252
|
+
- nsp
|
|
4253
|
+
type: string
|
|
4254
|
+
description: The type of the source system where this Card Slot is sourced from.
|
|
4255
|
+
example: nfmp
|
|
4256
|
+
SourceType3:
|
|
4257
|
+
title: SourceType3
|
|
4258
|
+
enum:
|
|
4259
|
+
- other
|
|
4260
|
+
- nsd
|
|
4261
|
+
- nfmp
|
|
4262
|
+
- nfmt
|
|
4263
|
+
- nrcp
|
|
4264
|
+
- nrct
|
|
4265
|
+
- nrcf
|
|
4266
|
+
- nrcx
|
|
4267
|
+
- mdm
|
|
4268
|
+
- nsp
|
|
4269
|
+
type: string
|
|
4270
|
+
description: The type of the source system where this LAG is sourced from.
|
|
4271
|
+
example: nfmp
|
|
4272
|
+
SourceType4:
|
|
4273
|
+
title: SourceType4
|
|
4274
|
+
enum:
|
|
4275
|
+
- other
|
|
4276
|
+
- nsd
|
|
4277
|
+
- nfmp
|
|
4278
|
+
- nfmt
|
|
4279
|
+
- nrcp
|
|
4280
|
+
- nrct
|
|
4281
|
+
- nrcf
|
|
4282
|
+
- nrcx
|
|
4283
|
+
- mdm
|
|
4284
|
+
- nsp
|
|
4285
|
+
type: string
|
|
4286
|
+
description: The type of the source system where this Network Element is sourced from.
|
|
4287
|
+
example: nfmp
|
|
4288
|
+
SourceType5:
|
|
4289
|
+
title: SourceType5
|
|
4290
|
+
enum:
|
|
4291
|
+
- other
|
|
4292
|
+
- nsd
|
|
4293
|
+
- nfmp
|
|
4294
|
+
- nfmt
|
|
4295
|
+
- nrcp
|
|
4296
|
+
- nrct
|
|
4297
|
+
- nrcf
|
|
4298
|
+
- nrcx
|
|
4299
|
+
- mdm
|
|
4300
|
+
- nsp
|
|
4301
|
+
type: string
|
|
4302
|
+
description: The type of the source system where this Port is sourced from.
|
|
4303
|
+
example: nfmp
|
|
4304
|
+
SourceType7:
|
|
4305
|
+
title: SourceType7
|
|
4306
|
+
enum:
|
|
4307
|
+
- other
|
|
4308
|
+
- nsd
|
|
4309
|
+
- nfmp
|
|
4310
|
+
- nfmt
|
|
4311
|
+
- nrcp
|
|
4312
|
+
- nrct
|
|
4313
|
+
- nrcf
|
|
4314
|
+
- nrcx
|
|
4315
|
+
- mdm
|
|
4316
|
+
- nsp
|
|
4317
|
+
type: string
|
|
4318
|
+
description: The type of the source system where this Shelf is sourced from.
|
|
4319
|
+
example: nfmp
|
|
4320
|
+
StandbyState:
|
|
4321
|
+
title: StandbyState
|
|
4322
|
+
enum:
|
|
4323
|
+
- providingService
|
|
4324
|
+
- standby
|
|
4325
|
+
type: string
|
|
4326
|
+
description: The standby state of this Card. Refer to the X.731 standard.
|
|
4327
|
+
example: providingService
|
|
4328
|
+
StandbyState1:
|
|
4329
|
+
title: StandbyState1
|
|
4330
|
+
enum:
|
|
4331
|
+
- providingService
|
|
4332
|
+
- standby
|
|
4333
|
+
type: string
|
|
4334
|
+
description: The standby state of this Card Slot. Refer to the X.731 standard.
|
|
4335
|
+
example: providingService
|
|
4336
|
+
StandbyState2:
|
|
4337
|
+
title: StandbyState2
|
|
4338
|
+
enum:
|
|
4339
|
+
- providingService
|
|
4340
|
+
- standby
|
|
4341
|
+
type: string
|
|
4342
|
+
description: The standby state of this LAG. Refer to the X.731 standard
|
|
4343
|
+
example: providingService
|
|
4344
|
+
StandbyState3:
|
|
4345
|
+
title: StandbyState3
|
|
4346
|
+
enum:
|
|
4347
|
+
- providingService
|
|
4348
|
+
- standby
|
|
4349
|
+
type: string
|
|
4350
|
+
description: The standby state of this Network Element. Refer to the X.731 standard.
|
|
4351
|
+
example: providingService
|
|
4352
|
+
StandbyState4:
|
|
4353
|
+
title: StandbyState4
|
|
4354
|
+
enum:
|
|
4355
|
+
- providingService
|
|
4356
|
+
- standby
|
|
4357
|
+
type: string
|
|
4358
|
+
description: The standby state of this Physical Link. Defaults to 'providingService'. Refer to the X.731 standard.
|
|
4359
|
+
example: providingService
|
|
4360
|
+
StandbyState5:
|
|
4361
|
+
title: StandbyState5
|
|
4362
|
+
enum:
|
|
4363
|
+
- providingService
|
|
4364
|
+
- standby
|
|
4365
|
+
type: string
|
|
4366
|
+
description: The standby state of this Port. Refer to the X.731 standard.
|
|
4367
|
+
example: providingService
|
|
4368
|
+
StandbyState6:
|
|
4369
|
+
title: StandbyState6
|
|
4370
|
+
enum:
|
|
4371
|
+
- providingService
|
|
4372
|
+
- standby
|
|
4373
|
+
type: string
|
|
4374
|
+
description: The standby state of this Shelf. Refer to the X.731 standard.
|
|
4375
|
+
example: providingService
|
|
4376
|
+
Type:
|
|
4377
|
+
title: Type
|
|
4378
|
+
enum:
|
|
4379
|
+
- physicalPort
|
|
4380
|
+
- networkElement
|
|
4381
|
+
- lag
|
|
4382
|
+
type: string
|
|
4383
|
+
description: The type of this Physical Link Endpoint. Mandatory property for creation.
|
|
4384
|
+
example: physicalPort
|
|
4385
|
+
Content-Type:
|
|
4386
|
+
title: Content-Type
|
|
4387
|
+
enum:
|
|
4388
|
+
- application/json
|
|
4389
|
+
type: string
|
|
4390
|
+
securitySchemes:
|
|
4391
|
+
RESTToken:
|
|
4392
|
+
type: apiKey
|
|
4393
|
+
name: Authorization
|
|
4394
|
+
in: header
|
|
4395
|
+
security: []
|
|
4396
|
+
tags:
|
|
4397
|
+
- name: cardSlots
|
|
4398
|
+
description: Cards Slots
|
|
4399
|
+
- name: cards
|
|
4400
|
+
description: Cards
|
|
4401
|
+
- name: lags
|
|
4402
|
+
description: Link Aggregation Groups
|
|
4403
|
+
- name: networkElements
|
|
4404
|
+
description: Network Elements
|
|
4405
|
+
- name: physicalLinks
|
|
4406
|
+
description: Physical Links
|
|
4407
|
+
- name: ports
|
|
4408
|
+
description: Ports
|
|
4409
|
+
- name: radioEquipment
|
|
4410
|
+
description: Radio Equipment
|
|
4411
|
+
- name: shelves
|
|
4412
|
+
description: Shelves
|