The GET /oms1350/networkinventory/networkelements request shall be used to retrieve the entire list of Network Elements stored in the NFM-T.
The GET /oms1350/networkinventory/networkelements/{neType} request shall be used to retrieve a list of only Network Elements stored in NFM-T of the specified type(s).
Table 1: Input Parameters to Retrieve a Filtered List of Network Elements
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
netype |
1830PSS_OCS 1830pss-1-ahp 1830pss 1830PSS_32 1830PSS_4 1830pss-1-md4h 1830pss-1-msah 1830pss-1-gbeh 1830pss-4 |
Mandatory |
List of one or more NE types separated by a comma. For example: GET /oms1350/networkinventory/networkelements/1830PSS_OCS or GET /oms1350/networkinventory/networkelements/1830PSS_OCS,1830pss |
The response to a GET /oms1350/networkinventory/networkelements request OR GET /oms1350/networkinventory/networkelements/{neType} request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain the attributes listed below for each network element. Network elements shall be returned regardless of the supervision state and communication state.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. "userLabel": "NewYorkMetro").
Table 2: Response for Retrieve a List of Network Elements
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
networkElements |
network element type | Mandatory | Network element which is mandatory for all the connections and services |
userLabel |
NE Name | Mandatory |
This is equivalent to the TID |
version |
Two Digit Number e.g. 8.2 | Mandatory |
NE Release Number |
productName |
PSS64 UNV UNV4 UNV8 UNV16 UNV16II UNV32 UNV96 |
Mandatory |
Shelf Type of Main Shelf |
nodeType |
1830PSS-1-AHP 1830PSS-1-GBEH 1830PSS-1-MD4H 1830PSS-1-MSAH 1830PSS-32 1830PSS-4 1830PSS-OCS |
Mandatory |
Type of node which is involved in network communication
|
location |
Mandatory |
location where the network element is installed | |
communicationState |
ENABLED , DISABLED |
Mandatory |
Sate of the network element whether it can be communicated via interfaces or commands |
supervisionState |
SUPERVISED, DECLARED |
Mandatory |
Sate of supervision(up or down) |
nodeName |
NE TID |
Mandatory |
For PHN NEs nodeName is the same as the userLabel. For standalone OCS NEs nodeName is the same as the userLabel. For compound PHN/OCS nodes the nodeName of the OCS NE is the userLabel of the PHN NE. |
attributeNameValue |
additional attribute name values | Optional | additional info about network element |
IpAddress |
Format XXX.XXX.XXX.XXX |
Mandatory |
For SNMP NEs MIB attribute tnSysConfiguredIpAddress |
TID |
NE TID |
Mandatory |
For SNMP NEs MIB attribute sysName |
neTypeDescription |
0-255 characters |
Optional |
Mandatory for SNMP NEs MIB attribute sysDescr |
EMLNeId |
Integer |
Optional |
NE id in SNA database |
EMLNeGroupId |
Integer |
Optional |
NE group id in SNA db |
GMREConfigured |
YES |
Optional |
Will be YES only if GMRE is configured on NE, else empty |
ClusterNEs |
Optional |
Header | |
ClusterNEName |
NE TID |
Optional |
MIB Parameter tnClusterFarEndNode |
ClusterNEIPAddress |
Format XXX.XXX.XXX.XXX |
Optional |
MIB Parameter tnClusterIpAddress |
Type |
Valid Values: OCS, PHN |
Optional |
Family type of the NE |
The GET /oms1350/networkinventory/equipments request shall be used to retrieve a list of equipment for the entire list of Network Elements stored in the NFM-T.
The GET /oms1350/networkinventory/equipments/{neType} request shall be used to retrieve a list of equipment for only Network Elements stored in NFM-T of the specified type(s).
The list of equipment shall include shelves, circuit packs, SFPs and XFPs.
Table 3: Input Parameters to Retrieve a Filtered List of Network Elements
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
netype |
1830PSS_OCS 1830pss-1-ahp 1830pss 1830PSS_32 1830PSS_4 1830pss-1-md4h 1830pss-1-msah 1830pss-1-gbeh 1830pss-4 |
Mandatory |
List of one or more NE types separated by a comma. For example: GET /oms1350/networkinventory/equipments/1830PSS_OCS or GET /oms1350/networkinventory/equipments/1830PSS_OCS,1830pss |
The response to a GET /oms1350/networkinventory/equipments request OR GET /oms1350/networkinventory/equipments/{neType} request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain a list of equipment with the attributes listed below for each piece of equipment.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. " NEName": "NewYorkMetro").
Table 4: Response for Retrieve a List of Equipment
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
Equipment |
Equipment installed in NE | Mandatory | Equipments on which connection services are running(card or shelf) |
NEName |
NE TID |
Mandatory |
Name of the Network element |
equipmentName |
Mandatory |
For example for shelves SHELF-<shelf> for PHN and SHELF-1-<shelf> for OCS. For example for cards <card name>-<shelf>-<slot> for PHN and or <card name>-1-<shelf>-<slot> for OCS. For example for modules <card name>-<shelf>-<slot>-<port> for PHN and or XFP-1-<shelf>-<slot>-<port> or SFP-1-<shelf>-<slot>-<port>for OCS. |
|
equipmentType |
Valid Values: Shelf, Card, Module,Slot |
Mandatory |
Modules only provided for PSS OCS NEs |
provisionedType |
Optional |
Provisioned equipment type. For example for shelves “PSS64”, for cards “10XANY10G” or “MT1T9” and for modules “fVOA” or “C113G4C” or “IR12G7TU”. |
|
actualType |
Optional |
Actual equipment type. For example for shelves “PSS64”, for cards “10XANY10G” or “MT1T9” and for modules “fVOA” or “C113G4C” or “IR12G7TU”. |
|
installedPartNumber |
Optional |
Provided for Cards | |
installedVersion |
Optional |
Version of the NE installed | |
installedSerialNumber |
Optional |
Serial number of the installed NE | |
cardMode |
flexMux, dualTran, sonetSdh,otu3, 100GbE, otu4, master, slave |
Optional |
Valid for 4DPA4, PSS1MD4, 43SCA1, 112SCA1 112SNA1, 130SNA1, 260SCX2, 1DPP24M, 43SCA1 |
holderState |
Optional |
Based on comparison of actual type and provisioned type. For example INSTALLED_AND_EXPECTED, EXPECTED_AND_NOT_INSTALLED, etc. |
|
pluggableTypes |
Port AID |
Optional |
Only provided for PSS OCS NEs For OCS <card name>-1-<shelf>-<slot>-<port>. |
primaryState |
Valid Values: IS, OOS-AU, OOS-MA, OOS-AUMA |
Optional |
Primary state of the equipment |
protectionRole |
Valid Values: Working, Protection |
Optional |
For matrix and controller cards |
attributeNameValue |
Optional | additional info of the NE | |
neType |
Format XXX.XXX.XXX.XXX |
Mandatory |
1830PSS-1-AHP 1830PSS-1-GBEH 1830PSS-1-MD4H 1830PSS-1-MSAH 1830PSS-32 1830PSS-4 1830PSS-OCS |
expectedPFAmps |
auto, 5, 7, 20, 30, 35, 50, 60, 65, 70, 150, 20.6, 8.5, 3.7, Mixed, 320, NA |
Optional |
MIB parameter tnShelfExpectedAmps |
expectedPFAmps_PFA |
3.7, 8.5, 20.6, N/A, AC7, DC30, NA |
Optional |
MIB parameter tnShelfExpectedPfa |
expectedPFAmps_PFB |
3.7, 8.5, 20.6, N/A, AC7, DC30, NA |
Optional |
MIB parameter tnShelfExpectedPfb |
oprMode |
fullRate, subRate, QinQ |
Optional |
Valid for 11DPE12, 11DPE12E, 11DPE12A MIB Parameter tn11dpge12CardRateMode MIB Parameter tn11dpe12aCardRateMode MIB Parameter tn11dpe12eCardRateMode |
protectionMode |
OCHP, OLP, OMSP |
Optional |
Valid for OPSA MIB Parameter tnOpsaProtectionMode MIB Parameter tnOpsCardProtectionMode |
shelfVoltageFloor |
3900-7200 |
Optional |
MIB parameter tnShelfVoltageFloor |
maxAddChannelCount |
8-88 |
Optional |
MIB parameter tnWssCardAddPathTotalChannel |
lineCount |
1-10 |
Optional |
MIB parameter tnWssCardReservedDegree |
pathTargetPower |
-10 to 10 |
Optional |
MIB parameter tnWssCardAddPathTargetPower |
provisionedFiberType |
ELEAF,ELEAFB, SSMF, SSMFB, TWRS |
Optional |
MIB parameter tnDcmCardProvisionedFiberType |
provisionedDistance |
None, 10, 20, 30, 40, 50, 60, 70, 80, 90, 110, 120, 130, 140, 160, 180, 200, 220, 240 |
Optional |
MIB parameter tnDcmCardProgrammedCompensationDistance |
fiberType |
0-5 characters |
Optional |
MIB parameter tnDcmCardFiberType |
The GET /oms1350/data/otn/networkinventory/alltopologicalinks request shall be used to retrieve a list of OTS and OS connections (internal and external OS) which have been deployed in the Network.
Only connections in Order Step “Commissioned” shall be returned.
No input parameters are required for this request.
The response to a GET /oms1350/data/otn/networkinventory/alltopologicalinks request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain the attributes listed below for each connection.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. " connectionName": "NewYorkMetro").
Table 5: Response for Retrieve a List of Physical Links
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
connectionName |
200 character string |
Mandatory |
Name of the Connection |
connectionRate |
OTS, OS |
Mandatory |
Container type of the connection |
direction |
unidirectional, bidirectional |
Mandatory |
The direction of the connection |
A1End |
Mandatory |
Header |
|
NEName |
NE TID |
Mandatory |
NE Name of A1 end port |
PortName |
Port ID |
Mandatory |
Port ID of A1 end PTP |
PortRate |
Rate of the Port |
Mandatory |
Rate of A1 end port |
Z1End |
Mandatory |
Header |
|
NEName |
NE TID |
Mandatory |
NE Name of Z1 end port |
PortName |
Port ID |
Mandatory |
Port ID of Z1 end PTP |
PortRate |
Rate of the Port |
Mandatory |
Rate of Z1 end port |
A2End |
Mandatory |
Header |
|
NEName |
NE TID |
Mandatory |
NE Name of A2 end port. If no A2 port return blank value. |
PortName |
Port ID |
Mandatory |
Port ID of A2 end port. If no A2 port return blank value. |
PortRate |
Rate of the Port |
Mandatory |
Rate of A2 end port. If no A2 port return blank value. |
Z2End |
Mandatory |
Header |
|
NEName |
NE TID |
Mandatory |
NE Name of Z2 end port. If no Z2 port return blank value. |
PortName |
Port ID |
Mandatory |
Port ID of Z2 end port. If no Z2 port return blank value. |
PortRate |
Rate of the Port |
Mandatory |
Rate of Z2 end port. If no A2 port return blank value. |
connectionState |
Deployed |
Mandatory |
NFM-T will return only connections deployed in the network (e.g. in effect/commissioned connections) |
comment |
255 Character String |
Optional |
Optional field to list additional information about the connection |
The GET /oms1350/data/otn/networkinventory/connections request shall be used to retrieve a list of network connections which have been deployed in the Network. Network connections are end-to-end connections defined across multiple nodes in the network.
This request shall trigger generation of an Inventory file that includes all the connection information. The generated ‘json’ file shall be compressed to tar.gz form.
The connections retrieved from NFM-T shall include all types of connections defined in NFM-T object model:-
The route of each connection shall be included.
No input parameters are required for this request.
The response to a GET /oms1350/data/otn/networkinventory/connections request shall ONLY contain the response status.
NOTE: Inventory file URL is not specified as part of response for this request.
The inventory data files shall contain the attributes listed below for each connection and the connection route.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. "CONNECTIONID": "521").
NOTE: Some of the attributes are for internal NFM-T use and some are not actively used. Description in this section focuses on attributes that will enable NFM-T client to build the connection model.
Table 6: Response for Retrieve a List of Deployed Connections
Attribute Name |
Valid Values |
Mandatory Optional | Description | |
---|---|---|---|---|
connectionData |
Mandatory |
Header |
||
CONNECTIONID |
Number |
Mandatory |
Unique Connection Identifier. |
|
CONNECTIONNAME |
200 Character String |
Mandatory |
Connection Name |
|
CONTAINERTYPE |
Character String |
Mandatory |
Container type for the connection |
|
NCGROUPID |
Number |
Optional |
Internal Use: Group Identifier for Integrated Connection Provisioning. Also used for re-arrange, broadcast, etc. |
|
CONNECTIONQUALIFIER |
Character String |
Optional |
Internal Use: Additional qualifier for system generated connection name |
|
CONNECTIONALIAS |
200 Character String |
Optional |
Alias for the connection name |
|
CONNECTIONRATE |
Number |
Mandatory |
Layer rate of the connection |
|
SERVICERATE |
Enumeration |
Mandatory |
The type of connection |
|
MSPAPSSWITCHTYPE |
Number |
Optional |
Internal Use: legacy SDH support |
|
CONNECTIONDIRECTION |
Enumeration |
Mandatory |
The directionality of the connection |
|
CONNECTIONCATEGORY |
Enumeration |
Mandatory |
Category of the connection in terms management ownership |
|
CONNECTIONSHAPE |
Enumeration |
Mandatory |
The shape of the connection |
|
CONNECTIONSTATE |
Enumeration |
Mandatory |
The current state of the connection |
|
ADAPTED |
Number |
Optional |
Not Used |
|
SERVICECONNECTION |
Enumeration |
Mandatory |
If the connection is a service connection or a trail/OS link |
|
ROUTESELECTIONMODE |
Enumeration |
Mandatory |
Routing Mode of the connection. |
|
IGNOREALARM |
Number |
Optional |
Not Used |
|
CUSTOMERNAME |
32 character String |
Optional |
Customer for connection included as part of connection creation. |
|
CUSTOMERPRIORITY |
Character String |
Optional |
Internal Use: Priority for Customer |
|
VPNID |
Character String |
Optional |
Not Used |
|
QUALITY |
Character String |
Optional |
Internal Use: Legacy SDH support |
|
DISCREPANCY |
Number |
Optional |
Internal Use: Identify discrepancy on connection or tpparameter. |
|
CREATIONTIME |
Number |
Mandatory |
Connection creation time in UTC |
|
CREATEDBY |
Enumeration |
Mandatory |
Connection Creator. |
|
SERVERGROUPID |
Number |
Optional |
Internal Use: legacy SDH support |
|
CAPACITY |
Number |
Optional |
Internal Use: legacy SDH support |
|
EFFECTIVERATE |
Character |
Mandatory |
Real Rate of Connection. | |
PROTECTIONROLE |
Enumeration |
Mandatory |
Internal Use: Legacy SDH support. |
|
PROTECTIONTYPE |
Enumeration |
Mandatory |
Provisioned Protection type of connection for GUI display. |
|
REVERTIVEMODE |
Enumeration |
Optional |
Mode of reversion of connection. |
|
SERVERLAYERRATE |
Number |
Mandatory |
Server Layer rate for DSR service connection. |
|
CONNECTIONTYPE |
Enumeration |
Optional |
Type of connection. |
|
TANDEMASSOCIATIONTAG |
Number |
Optional |
Internal Use: Legacy SDH support |
|
CONNECTIONNAMEFORMAT |
Enumeration |
Optional |
Connection name format specified by user. |
|
DISPLAYSERVICERATE |
Enumeration |
Mandatory |
Internal Use: Rate of the service for display. |
|
MANUALFAULTMARKINGSTATUS |
Number |
Optional |
Not Used |
|
LOCKEDCAPACITY |
Number |
Optional |
Internal Use: Legacy SDH support |
|
RESTORATIONTRIGGER |
Number |
Optional |
Not Used |
|
INDIRECTSNCNAME |
Character String |
Optional |
Internal Use: Legacy SDH support |
|
SDHCONNECTIONID |
Character String |
Optional |
Internal Use: Legacy SDH support |
|
SDHCLIENTID |
Character String |
Optional |
Internal Use: Legacy SDH support |
|
SDHROUTEMODTIME |
Character String |
Optional |
Internal Use: Legacy SDH support |
|
OMSPTRAILID |
Number |
Optional |
Connection Identifier of the OMSP trail for OMSP connection |
|
SYSTEMLABEL |
Character String |
Optional |
Not Used |
|
TCMSTATUS |
Number |
Optional |
Internal Use: Tandem Connection Monitoring status for odu, out connections. Values can NA, enabled or disabled. |
|
SERVICESTATE |
0,1,2,3 |
Mandatory |
0-NA 1-ON 2-OFF 3-PARTIAL |
|
OPERATIONALSTATE |
0,1 |
Mandatory |
0 – enabled 1 - disabled |
|
INVARIANTCONNID |
Number |
Mandatory |
Internal Use: Connection Identifier used by Northbound Interface client. |
|
CONNECTIONLEVEL |
Number |
Optional |
Internal Use: Identifier for primary, secondary connections in integrated provisioning |
|
NCGIDFORMDFY |
Number |
Optional |
Not Used |
|
ASSOCIATEDNPRTLID |
Number |
Mandatory |
Identifier used in NPR component. Internal to NFM-T. |
|
PREFERREDRESTORATIONMODE |
Character String |
Optional |
Preferred Restoration Mode for Control Plane connections. |
|
ASAPID |
Number |
Optional |
Internal Use: ASAP identifier |
|
ANE1NAME |
32 character string |
Mandatory |
NE name of A1 end port |
|
ZNE1NAME |
32 character string |
Mandatory |
NE name of Z1 end port |
|
ATP1NAME |
Refer R13.2 Port ID document |
Mandatory |
Port ID of A1 end port |
|
ZTP1NAME |
Refer R13.2 Port ID document |
Mandatory |
Port ID of Z1 end port |
|
ANE2NAME |
32 character string |
Optional |
NE name of A2 end port |
|
ZNE2NAME |
32 character string |
Optional |
NE name of Z2 end port |
|
ATP2NAME |
Refer R13.2 Port ID document |
Optional |
Port ID of A2 end port |
|
ZTP2NAME |
Refer R13.2 Port ID document |
Optional |
Port ID of Z2 end port |
|
routeData |
Mandatory |
Header |
||
SERVERID |
Number |
Optional |
Unique Connection Identifier for server layer connection |
|
NCGROUPID |
Number |
Optional |
Group Identifier for Integrated Connection Provisioning for server layer. |
|
SERVERLINKNAME |
200 character string |
Optional |
Connection name for server layer connection |
|
CONTAINERTYPE |
Optional |
Container type for the server layer connection |
||
CONNECTIONTYPE |
Enumeration |
Optional |
Type of server connection. |
|
CONNECTIONRATE |
Number |
Mandatory |
Layer rate of the server connection |
|
PROTECTIONTYPE |
Enumeration |
Mandatory |
Provisioned Protection type of server connection. |
|
IMMEDIATESERVER |
Enumeration |
Mandatory |
Identifies connection as being in IMMEDIATE server layer. |
|
FREQUENCY |
Set of 2 channel numbers. |
Optional |
Frequency used for server layer connection. Only applicable for OTUk (OCH) connect. Two frequencies are used when the connection is a 4-ended connection. |
|
ROUTEPROTECTIONTYPE |
Set of 2 numbers |
Optional |
Role of the server layer connection as part of a protected entity Two entries are used when the connection is a 4-ended connection. |
NOTE: Following sections describe possible values for the attributes and their use. Attributes required by client to navigate the connection hierarchy are described with a ‘Usage e.g.’ description as well.
This parameter identifies the type of connection. It can have following values:-
SERVICERATE
SERVICE = 1
TRAIL /OS = 2
Usage e.g.: Identifying service connections and trails in the inventory file.
This parameter indicates the directionality of the connection. It can have following values:-
CONNECTIONDIRECTION
NA = 0
UNI = 1
BID = 2
This parameter indicates category of the connection in terms management ownership. It can have following values:-
CONNECTIONCATEGORY
NA = 0
MANAGED_PLANE = 1
CONTROLLED_PLANE = 2
MANAGED_AND_CONTROLLED_PLANE = 3
MIXED_PLANE = 4
GMRE_CONNECTION = 5
GMRE_AND_MANAGED_PLANE = 6
EXTERNAL_OWNED_CONNECTION = 7
MIXED_OWNERSHIP_MANAGED_PLANE_CONNECTION = 8
RAW_CONNECTION = 9
ASON_IMPLICIT_SERVER = 10
ASON_LOGICAL_LINK = 11
ASON_EDGE_DROP_LINK = 12
ASON_LOGICAL_EDGE_DROP_LINK = 13
ASON_MRN_LOGICAL_LINK = 14
ASON_MRN_TERM_LINK = 15
MP_IMPLICIT_SERVER = 16
EDGE_HO_TRAIL = 17
ASON_EDGE_HO_TRAIL = 18
Usage e.g.: Identifying connections managed by NMS (MANAGED_PLANE(1)) or those managed by control plane (GMRE_CONNECTION(5)).
This parameter indicates the shape of the connection.
It can have following values:-
CONNECTIONSHAPE
NA = 0
ADD_DROP_A = 1
ADD_DROP_Z = 2
INTERCONNECT = 3
DOUBLE_INTERCONNECT = 4
DOUBLE_ADD_DROP = 5
OPEN_ADD_DROP = 6
EXPLICIT = 7
SIMPLE = 8
DOUBLE_SIMPLE = 9
SAME_ENDED = 10
INTERCONNECT_W = 11
INTERCONNECT_P = 12
SAME_ENDED_SRC = 13
SAME_ENDED_SINK = 14
ADD_DROP_S = 15
DOUBLE_ADD_DROP_D = 16
DOUBLE_ADD_DROP_S_FOR_ROUTE_ONLY = 17
SIMPLE_DRI = 18
DROP_AND_CONTINUE = 19
Usage e.g.: Determine the shape at endpoints of the connection. ‘Simple’ used to indicate typical 2-ended connections. Double_Add_Drop (5) typically used with 4-ended connection e.g. with diverse path protection.
This parameter indicates the current state of the connection. It can have following values:-
CONNECTIONSTATE
NA = 0
PLANNED = 1
LOCAL_DESIGN = 2
LOW_LEVEL_DESIGN_IN_PROGRESS = 3
LOW_LEVEL_DESIGN_FAILED = 4
LOW_LEVEL_DESIGN = 5
IMPLEMENTATION_IN_PROGRESS = 6
IMPLEMENTATION_FAILED = 7
IMPLEMENTATION = 8
IN_EFFECT = 9
HISTORY = 10
PREPLAN_COMPLETE = 11
LOCAL_DESIGN_IN_PROGRESS = 12
LOCAL_DESIGN_FAILED = 13
Usage e.g.: Filter all commissioned (IN_EFFECT=9) connections in the file. Client may not require connections that are in planned or designed state.
This parameter indentifies if the connection is a service connection or a trail/OS link. It can have following values:-
SERVICECONNECTION
SERVICE = 1
TRAIL /OS = 0
Usage e.g.: Filter out all service connections in the network. Top-down approach can then be used to identify all the server layer connections.
This parameter indicates the mode for route selection of the connection. It can have following values:-
ROUTESELECTIONMODE
NA = 0
AUTOMATIC = 1
PARTIAL = 2
MANUAL = 3
FS_CHANNELS = 4
FS_XC = 5
FS_CHANNELS_ORDER_SENSITIVE = 6
Usage e.g.: Identify automatic routed versus manual routed connections.
This parameter indicates how the connection was created. It can have following values:-
CREATEDBY
NA = 0
USER = 1
SYSTEM = 2
NORTH_BOUND = 3
HA = 4
COMMAND_LINE = 5
INSERT_REMOVE_NODE = 6
BULK_PROV = 7
SDH = 8
SYSTEM_NOTIF = 9
NPR = 10
SDH_GMRE = 11
Usage e.g.: Identify connections created by USER (1) or northbound client (3) or discovered from network (10).
This parameter indicates the effective layer rate of the connection (applicable for EFFECTIVERATE, SERVERLAYERRATE). It can have following values:-
Table 7: Layer Rates
LAYERRATENAME | LAYERRATEVALUE | SONETNAME | SDHNAME |
---|---|---|---|
unknown |
1 |
||
not_applicable |
2 |
||
vcg_broadcast |
3 |
||
physical_optical |
10 |
||
os |
20 |
||
ots |
30 |
||
oms |
40 |
||
omsband |
45 |
||
dsr |
200 |
||
dsr_40g |
205 |
||
dsr_10g |
210 |
||
dsr_2_5g |
215 |
||
dsr_2_5gubb |
220 |
||
dsr_1_25gubb |
225 |
||
och |
230 |
||
otu4x2 |
232 |
||
otu3e2 |
233 |
||
otu4 |
234 |
||
ocht |
235 |
||
odu4 |
236 |
||
otu |
237 |
||
odu3e2 |
238 |
||
otu3 |
239 |
||
odu3 |
240 |
||
otl4.4 |
241 |
||
otu2e |
242 |
||
odu2e |
243 |
||
otu2 |
244 |
||
odu2 |
245 |
||
otu1f |
246 |
||
odu1f |
247 |
||
oduflex |
248 |
||
otu1 |
249 |
||
odu1 |
250 |
||
odu0 |
252 |
||
och_dsr |
255 |
||
odu2_dsr |
260 |
||
physical_electrical |
300 |
||
dsr_5gb |
305 |
||
dsr_pct |
310 |
||
dsr_oc768_stm256 |
315 |
||
dsr_oc192_stm64 |
320 |
||
dsr_oc48_stm16 |
325 |
||
dsr_622m |
330 |
||
dsr_oc12_stm4 |
335 |
||
dsr_155m |
340 |
||
dsr_oc3_stm1 |
345 |
||
dsr_oc3_stm1_xc |
342 |
||
dsr_oc1_stm0 |
350 |
||
dsr_gbe |
400 |
EPORT-1GE |
EPORT-1GE |
dsr_10gbe |
403 |
EPORT-10GE |
EPORT-10GE |
dsr_fast_ethernet |
405 |
EPORT-FE |
EPORT-FE |
dsr_40gbe |
406 |
EPORT-40GE |
EPORT-40GE |
elink |
410 |
||
dsr_100gbe |
411 |
EPORT-100GE |
EPORT-100GE |
dsr_hsbb |
415 |
||
dsr_lsbb |
420 |
||
dsr_lan8 |
430 |
||
dsr_x21 |
440 |
||
eos |
505 |
||
atm |
500 |
ATM |
ATM |
mau |
550 |
MAU |
MAU |
tmpls_channel |
450 |
||
tmpls_path |
451 |
||
tmpls_section |
452 |
||
dsr_140m |
600 |
||
dsr_45m |
605 |
T3 |
T3 |
dsr_34m |
610 |
||
dsr_2m |
615 |
E1 |
E1 |
dsr_1_5m |
620 |
T1 |
T1 |
dsl |
625 |
||
oc768_rs_stm256 |
700 |
||
oc192_rs_stm64 |
705 |
||
oc48_rs_stm16 |
710 |
||
oc12_rs_stm4 |
715 |
||
oc3_rs_stm1 |
720 |
||
oc1_rs_stm0 |
725 |
||
oc768_ms_stm256 |
800 |
OC768 |
STM256 |
oc192_ms_stm64 |
805 |
OC192 |
STM64 |
oc48_ms_stm16 |
810 |
OC48 |
STM16 |
oc12_ms_stm4 |
815 |
OC12 |
STM4 |
oc3_ms_stm1 |
820 |
OC3 |
STM1 |
oc1_ms_stm0 |
825 |
||
ec1_stm0 |
830 |
EC1 |
EC1 |
gbe |
1000 |
||
oam |
1003 |
||
fast_ethernet |
1005 |
||
ethernet |
1006 |
||
encapsulation |
1008 |
||
hsbb |
1010 |
||
lsbb |
1015 |
||
fddi |
1020 |
||
ficon |
1025 |
||
escon |
1028 |
||
fragment |
1030 |
VCG |
VCG |
lag_fragment |
445 |
||
data |
1035 |
||
concatenation |
1040 |
||
ethernet_qos |
1045 |
||
ethernet_rpr |
1046 |
||
ethernet_rtd |
1047 |
||
ethernet_lq |
1048 |
||
ethernet_hq |
1049 |
||
ethernet_cong |
1050 |
||
pje |
1051 |
||
sts768c_vc4_256c |
1100 |
STS768 |
VC4256C |
sts192c_vc4_64c |
1105 |
STS192 |
VC464C |
sts48c_vc4_16c |
1110 |
STS48 |
VC416C |
sts12c_vc4_4c |
1115 |
STS12 |
VC44C |
sts3c_au4_vc4 |
1120 |
STS3 |
VC4 |
sts1_au3 |
1125 |
STS1 |
VC3 |
mixed_vc3 |
1150 |
HO_VC3-LO-VC3 |
STS1_LO-VC3 |
tu3_vc3 |
1155 |
||
vt6_tu2_vc2 |
1160 |
||
vt2_tu12_vc12 |
1165 |
VC12 |
VC12 |
vt1_5_tu11_vc11 |
1170 |
VT1 |
VC11 |
sts192c_pipe |
1205 |
STS192_pipe |
|
sts48c_pipe |
1210 |
STS48_pipe |
|
sts12c_pipe |
1215 |
STS12_pipe |
|
sts3c_pipe |
1220 |
STS3_pipe |
|
sts1_pipe |
1225 |
STS1_pipe |
|
sts1-xv |
1300 |
||
sts3c_vc4-xv |
1310 |
||
tu3_vc3-xv |
1315 |
||
vt2_tu12_vc12-xv |
1320 |
||
vt2_tu12_vc12-xg |
1325 |
||
e4_140m |
1400 |
||
e3_34m |
1405 |
||
e1_2m |
1410 |
||
t3_ds3_45m |
1415 |
||
t1_ds1_1_5m |
1420 |
||
x21 |
1425 |
||
ethernet_service |
1500 |
||
vsn |
1505 |
||
epl |
1510 |
||
vlan |
1515 |
||
hs |
1520 |
||
bits |
1600 |
||
bits_out |
1605 |
||
slm |
48 |
||
odu4tcm |
575 |
||
odu3e2tcm |
578 |
||
odu3e1tcm |
579 |
||
odu3tcm |
580 |
||
odu2etcm |
586 |
||
odu2tcm |
585 |
||
odu1tcm |
590 |
||
oduftcm |
592 |
||
odu0tcm |
595 |
Usage e.g.: Determine the real layer rate of the connection. It is real layer rate of connection based on signalType, provisionBitRate. For example, sometime connection rate is odu3 but effectiverate is odu3e2. Field can be used to filter all trails at various ODU/OTU rates.
This parameter indicates the role of the connection within a protection entity. Used for legacy support only. It can have following values:-
PROTECTIONROLE
NA = 0
SERVICE = 1
PROTECTION = 2
This parameter indicates the protection type of connection. It can have following values:-
PROTECTIONTYPE
NA = 0
UN_PROTECTED = 1
PROTECTED = 2
YCABLE = 3
OPSA = 4
OPSB = 5
SNCP = 6
OMSP = 7
SERVER_PROTECTED = 8
Usage e.g.: Identify the specific provisioned protection type of the connection. Value PROTECTED(2) is used to indicate L1 (OCS) connection protection.
This parameter indicates the mode of reversion supported for the protected connection. It can have following values:-
REVERTIVEMODE
NA = 0
REVERTIVE = 1
NONREVERTIVE = 2
REVERTIVE_AUTO = 3
REVERTIVE_MAN = 4
Usage e.g.: Determine if connection is revertive or non-revertive and if reversion is automatic or manual. It used with Y-cable on PHN NE and SNCP on OCS NE.
This parameter indicates the type of connection. It can have following values:-
CONNECTIONTYPE
REGULAR = 0
TANDEM = 1
NOTAPPLICABLE = 2
LOPC = 3
VIRTUAL_SERVER = 4
This parameter indicates the name format of the connection. It can have following values:-
CONNECTIONNAMEFORMAT
NA = 0
FREEFORMAT = 1
TELECORDIA = 2
M1400 = 3
PORTBASED = 4
This parameter indicates the restoration type for the control plane connection. It can have following values:-
PREFERREDRESTORATIONMODE
RESTORATION_SOURCEBASED = SBRPROTECTED
RESTORATION_GUARENTEED = GUARANTEED
Usage e.g.: Identify the provisioned restoration type of the connection.
This parameter is part of the server layer connection included in the route of a connection. It indicates the role of the server layer connection for the protected upper layer connection. It can have following values:-
ROUTEPROTECTIONTYPE
NA = 0
UNPROTECTED = 1
SERVICE (WORKING LEG) = 2
PROTECTION (PROTECTING LEG)= 3
Usage e.g.: Identify that server layer connection is part of Working Leg (SERVICE=2) or part of Protection leg (PROTECTION=3) route of the protected connection.
The response for ‘retrieve of list of connections’ will include all the connections in the NFM-T database. Clients need to filter it based on their requirements.
Following are some ways to filter the data in the Inventory file:-
- Filter for Deployed Commissioned Connections (Use Parameter: CONNECTIONSTATE; Value: IN_EFFECT(9) )
- Filter for connections on NE’s (Use Parameter -> ANE1NAME, ZNE1NAME, ANE2NAME, ZNE2NAME; Value: NE_name)
- Filter for topological connections (Use Parameter -> CONTAINERTYPE; Value: ‘os’, ‘ots’)
- Filter for OMS link connections (Use Parameter -> CONTAINERTYPE; Value: ‘oms’)
- Filter for End to end Services (Use Parameter -> SERVICERATE; Value: 1)
- Filter for HO-ODU Trails (Use Parameter -> EFFECTIVERATE; Value: ‘odu4’, ‘odu3’, ‘odu2’)
- Filter for LO-ODU Trails (Use Parameter -> EFFECTIVERATE; Value: ‘odu2’, ‘odu1’, ‘odu0’)
Navigating the Connection Route Hierarchy:-
The route of a connection provides references to all the server layer connections under it. Following steps can be used to navigate the route one server layer at a time.
For a given connection,
- Filter Immediate Server Layer connections based on attribute ‘IMMEDIATESERVER’ in the connection routeData.
- Filter Immediate Server layer connections (only for DSR connections) based on server layer rate. (Use Parameter -> SERVERLAYERRATE which is the rate of the immediate server layer).
- Filter Immediate Server layer connections based on protection role provided by the server. (Use Parameter -> ROUTEPROTECTIONTYPE which is populated only for immediate server layer connections in the route).
The interface data model is based on the NFM-T internal data model. Any analysis of the model should include a study of the NFM-T optical model. Following rules are noteworthy:-
1. The data model on the interface follows a hierarchical model.
2. All the relevant layers in the optical model are represented in the hierarchy as well.
3. All navigation is top-down. Parsing of connection data can start from a connection at any layer but can only proceed towards server layers to build end to end route.
4. Immediate server layer for any connection is identifiable, by means of an attribute ‘IMMEDIATESERVER’. Thus, it allows for a step-by-step single layer navigation through the model.
5. Protection is represented at connection layer and it’s immediate server layer only. Server layer identifies the entities that are part of the Working, Protection or Unprotected connection route.
6. Protection in NFM-T is implemented ONLY at either ODU, OCH or OMS layer. There may be cases where the client connection (DSR layer) may be protected but protection is implemented ONLY at mapped ODU layer.
7. Clients can choose to work ONLY with the layers that they model. However, to fully recreate the end-to-end connection and route for all configurations, IT is RECOMMENDED to perform step-by-step navigation through each layer in the model.
The following is a proposed approach for parsing the JSON structure data.
- Start with a connection filtered based on layer OR service/trails.
- If (Layer Required by the client), refer ‘connectionData’:-
o Identify/Validate service or trail/os. (SERVICERATE)
o Identify/Validate Protection scheme as unprotected or protected or L0 protection scheme. (PROTECTIONTYPE)
o Identify/Validate domain as MP, CP or MPCP. (CONNECTIONCATEGORY)
o Identify Type of restoration if applicable (PREFERREDRESTORATIONMODE)
o Identify/Validate type of connection as regular or logical link (LOPC). (CONNECTIONTYPE = 3)
- Identify/Validate Immediate Server Layer connections from ‘routeData’ by looking for entities with attribute ‘IMMEDIATESERVER = YES’. There may be more than 1 server connection.
- For protected connections, identify/validate both W & P leg server layer connections. Attribute ‘IMMEDIATESERVER = YES’ and ‘ROUTEPROTECTIONTYPE=2 or 3’ for W & P respectively.
Note the following:-
o ROUTEPROTECTIONTYPE Field is non-zero only for immediate server layer ONLY.
o Non-zero value describes the manner in which server layer connection supports the route of the client connection. Values of 1 – unprotected, 2 – working leg, 3 – protection leg.
Thus, if connection is protected, it is expected to see 2 instances of immediate server connections with ROUTEPROTECTIONTYPE set to 2 & 3 respectively.
o As described in Rules above, it should be remembered during navigation that protection is ONLY implemented in NFM-T at ODU, OCH or OMS layer.
- Each route in server layer, whether unprotected or working / protecting legs, can again consist of multiple connections that build the end-to-end route. All the entities should be identified to stitch route correctly.
o When there are multiple server layer entities, match A & Z nodes with connection to stitch the complete end to end route. This is required especially when there are 3R (regens) in the path or OCS-based electrical regeneration as well.
- For each Immediate Server Layer connection, repeat the above described logic.
- Stop algorithm when desired connection Layer is reached. E.g.
o OS/OTS if all layers till physical layer has to be traversed.
o OTUk layer (OTU2, OTU3, OTU4) if only HO-ODU layer has to be traversed.
The GET /oms1350/data/otn/networkinventory/connectionstatus request shall be used to retrieve status of the connection file generation request.
This request shall fetch the status of the last connection file generation request.
No input parameters are required for this request.
The response to a GET /oms1350/data/otn/networkinventory/connectionstatus request shall contain the response status and HTTP URL where the inventory data file can be accessed.
NOTE: HTTP URL for inventory data file shall be available ONLY when the response status is SUCCESS.
The response to all requests shall include a response header with the attributes listed below.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. " originatorApp": "NFM-T ").
Table 8: Data for Response Header Section
Attribute Name |
Valid Values |
Mandatory Optional | Description | |
---|---|---|---|---|
originatorApp |
NFM-T, NPT |
Mandatory |
Originator App Name |
|
objectType |
Valid Values: project, oduk, demand, route, equipment, networkElements, physicalPorts, routeIds, connections |
Mandatory |
The following Object Type values shall be used: For retrieve a list of network elements: “networkElements” For retrieve a list of equipment: “equipment” For retrieve a list of PTPs: “physicalPorts” For retrieve a list of connections: “connections” |
|
objectScope |
Valid Values: network, project, routeDetail, routeIds, connections |
Mandatory |
The following Object Scope values shall be used: For retrieve a list of network elements: “network” For retrieve a list of equipment: “network” For retrieve a list of PTPs: “network” For retrieve a list of demands from OMS: “network” For retrieve a list of oduk from OMS: “network” For retrieve a list of connections from OMS: “connections” |
|
responseStatus |
Valid Values: success, failed, partial_success, IN_PROGRESS |
Mandatory |
Status of the response |
|
fileGenerationTime |
Valid Values: null, date & time |
Optional |
Date & Time described in format : "30/11/2015 10:45:17" |
|
errorCode |
40 character string |
Optional |
Defined for Future Use |
|
errorReason |
255 character string |
Optional |
Mandatory for failed or partial success |
|
errorParams |
Optional |
Optional for failed or partial success |
||
param1 |
40 character string |
Optional |
Optional for failed or partial success |
|
param2 |
40 character string |
Optional |
Optional for failed or partial success |
|
… |
40 character string |
Optional |
Optional for failed or partial success |
|
param<n> |
40 character string |
Optional |
Optional for failed or partial success |
There are two REST calls available for port retrievals. The attributes retrieved vary for each of them.
/oms1350/networkinventory/physicalports - Retrieves a subset of attributes for all the NEs on a per NE basis.
/oms1350/networkinventory/allphysicalports - Retrieves exhaustive set of attributes for all the NEs as a single file.
The GET /oms1350/networkinventory/physicalports request shall be used to retrieve a list of all PTPs for all Network Elements stored in NFM-T.
For PSS OCS Network Elements PTPs shall only be returned for assigned ports. Unassigned ports which use the MDL-<shelf>-<slot>-<port> format are not stored in NFM-T and shall not be returned.
No input parameters are required for this request.
The response to a GET /oms1350 oms1350/data/otn/networkinventory/physicalports request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain the attributes listed below for each port.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. "NEName": "NewYorkMetro").
Table 9: Response for Retrieve a List All Physical Ports
Attribute Name |
Valid Values |
Mandatory Optional | Description |
---|---|---|---|
physicalPorts |
Mandatory |
Physical port information |
|
otnNeid |
number |
Mandatory |
OTN NE id |
NEName |
32 character string |
Mandatory |
NE name |
PortName |
See Reference [2]for Valid Values |
Mandatory |
Port ID |
PortRate |
See Reference [2]for Valid Values |
Mandatory |
Port rate |
signalType |
“ ” (Empty), OC-3, OC-12, OC-48, OC-192, OC-768, OTU1, OTU1F, OTU2, OTU2e, UNKNOWN, OTU3, OTU4, OTU4x2, 1GbE, 10GbE, 40GbE, 40GbE MLD, 100GbE, E1, STM-1, STM-4, STM-16, STM-64, STM-256, FC100, FC200, FC400, FC800, FC1200, FC1600, CBR2G5, CBR10G3, DVBASI, SDSDI, HDSDI, 3GSDI, FE, OCH, OTS, SDR, DDR, OTL4.4, OTL4.10, 10GbE-LAN, OTS, TENGIGELANETH, GIGELANETH, FELANETH, HUNDREDGIGELANETH, OTU2EWANETH, HUNDREDGIGE, OC3, STM1, OC12, STM4, OC48, STM16, OC192, STM64, 1GbE, 10GbE, 1GbEConv, OTSI, 400GbE |
Optional |
Signal type assigned on port |
primaryState |
IS, OOS-AU, OOS-MA, OOS-AUMA |
Optional |
Primary State of the port |
secondaryState |
Maintenance,Supporting Entity Outage, SGEO,PMD, BUSY,SDEE,TRM, FAF, Unassigned, Facility Failure, CPMP |
Optional |
Secondary state of the port |
portNumber |
shelf/slot/port format |
Optional |
Port number in shelf/slot/port format |
cardName |
Equipment AID |
Mandatory |
<card name>-<shelf>-<slot> for PHN and or <card name>-1-<shelf>-<slot> for OCS. |
Frequency |
Format: NNNN.XXX (e.g. 9400.000). |
Optional |
Frequency on port |
The GET /oms1350/networkinventory/allphysicalports request shall be used to retrieve a list of all PTPs for all Network Elements stored in NFM-T.
For PSS OCS Network Elements PTPs shall only be returned for assigned ports. Unassigned ports which use the MDL-<shelf>-<slot>-<port> format are not stored in NFM-T and shall not be returned.
No input parameters are required for this request.
The response to a GET /oms1350 oms1350/data/otn/networkinventory/allphysicalports request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain the attributes listed below for each port.
In the table below the term “Direct Mapping” means the valid values of the field are exactly the values returned for the MIB parameter.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. "NEName": "NewYorkMetro").
Table 10: Response for Retrieve a List of Physical Ports
Attribute Name |
Valid Values |
Mandatory Optional | Description | |
---|---|---|---|---|
physicalPorts |
Mandatory |
Physical ports information |
||
NEName |
NE TID |
Mandatory |
name of the NE |
|
PortName |
See Reference [2]for Values |
Mandatory |
Port AID |
|
PortRate |
See Reference [2]for Values |
Mandatory |
Rate on port e.g. OTS,OS |
|
signalType |
See Reference [5]for Values |
Mandatory |
Assigned Signal Rate e.g. OTS,OS |
|
oppositeDirectionPort |
Port ID e.g. AHPHG-[1..8]-[7,8]-LINE |
Optional |
Opposite Direction Port ID |
|
pluggableModuleType |
Auto, User, SS-1.1, etc. |
Optional |
Pluggable Module Type of the port |
|
installedPartNumber |
Direct Mapping |
Optional |
MIB Parameter tnSfpPortUnitPartNum |
|
eptDemandName |
Direct Mapping |
Optional |
MIB Parameter tnDwdmCmnLinePortDemandName |
|
oprMode |
fullRate, subRate, QinQ |
Optional |
Card rate Mode |
|
Frequency |
Format NNNN.XXX e.g. 9410.000 |
Optional |
Channel frequency of the port |
|
receiveFrequency |
Format NNNN.XXX e.g. 9410.000 |
Optional |
Channel receive frequency of the port |
|
fec |
AFEC, EFEC, EFEC2, HPFEC, NOFEC, RSFEC, SDFEC, SDFEC-G2, UFEC, USDFEC |
Optional |
OT Line and Client Ports |
|
Encoding |
8QAM, 16QAM, QPSK, SP-QPSK, 16QAM-250G, BPSK, 16SQAM, 64QAM |
Optional |
Encoding of the line port |
|
waveShape |
Single, Super, Alien |
Optional |
Wave shape of the line port |
|
monitoredPort |
Port ID |
Optional |
Monitored Port ID |
|
connectedLDOTDRPort |
Port ID e.g. AHPHG-[1..8]-[7,8]-LINE |
Optional |
Connected LDOTDR Port ID |
|
PtpioSigPortConnFrom |
Port ID e.g. AHPHG-[1..8]-[7,8]-LINE |
Optional |
OMS PTPIOConnectedFromPort MIB Parameter tnPtpioPortConfigSigPortConnFromPort |
|
PtpioSigPortConnTo |
Port ID e.g. AHPHG-[1..8]-[7,8]-LINE |
Optional |
OMS Parameter PTPIOConnectedToPort MIB Parameter tnPtpioPortConfigSigPortConnToPort |
|
connectedLineDCM |
<shelf>/<slot>/DCM |
Optional |
MIB Parameter tnIroadmPortConfigLineDcmConnAddress |
|
connectedLinePort |
IROADM-<shelf>-<slot>-<port> |
Optional |
MIB Parameter tnDcmPortInfoIroadmConnAddress |
|
minPlannedLossIn |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeMinPlannedLossIn |
|
maxPlannedLossIn |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeMaxPlannedLossIn |
|
typicalPlannedLossIn |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeTypicalPlannedLossIn |
|
minPlannedLossOut |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeMinPlannedLossOut |
|
maxPlannedLossOut |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeMaxPlannedLossOut |
|
typicalPlannedLossOut |
Direct Mapping |
Optional |
MIB Parameter tnWaveKeyDecodeTypicalPlannedLossOut |
|
actualTilt |
Direct Mapping |
Optional |
Actual tilt of the port |
|
allowedGainDelta |
Direct Mapping |
Optional |
MIB parameter tnAmplifierPortPowerDeltaMax |
|
Attenuation |
Direct Mapping |
Optional |
Attenuation of the port |
|
autoEgressAdjustment |
YES, NO |
Optional |
MIB parameter tnPowerMgmtPortEgressAdjustForDownstreamEnabled |
|
egressOAPpcOut |
-10 to 10 |
Optional |
MIB Parameter tnPowerMgmtIroadmEgressOAPpcOut This is a card level parameter is mapped to IROADMV LINEOUT OTS(30) and IROADMF LINEOUT OTS(30) |
|
egressRipple |
Direct Mapping |
Optional |
MIB parameter tnIroadmPortConfigEgressOaRippleToRemove |
|
fiberLength |
Direct Mapping |
Optional |
The value of the Fiber Length parameter shall be included in the upload file only if the port supports provisioning on the Network Element of Fiber Length. |
|
fiberType |
DSF, ELEAF, LS, SSMF, TWC, TWP, TWRS |
Optional |
The value of the Fiber Type parameter shall be included in the upload file only if the port supports provisioning on the Network Element of Fiber Type. |
|
forcedPerChannelOutputPower |
Direct Mapping -99 -> Off |
Optional |
MIB parameter tnIroadmPortConfigForcedTargetPpcOut |
|
gain |
Direct Mapping |
Optional |
MIB parameter tnAmplifierPortPowerGain |
|
gainMode |
LOW, HIGH |
Optional |
MIB parameter tnAmplifierPortGainRange |
|
gainTilt |
Direct Mapping |
Optional |
Gain tilt of the port |
|
ingressRippleAllowance |
Direct Mapping |
Optional |
MIB parameter tnPowerMgmtIngressRippleAllowance |
|
initialLoss |
Direct Mapping |
Optional |
MIB parameter tnAmplifierHybridPortInitialMidLoss |
|
initialTargetGain |
Direct Mapping |
Optional |
Initial Agc Target Gain of the port |
|
inputToOutputGain |
Direct Mapping |
Optional |
Input to Output gain of the port |
|
maxAttenuation |
Direct Mapping |
Optional |
MIB parameter tnAmplifierHybridPortVoaMaxAttenuation |
|
maxGain |
Direct Mapping |
Optional |
Power Gain Max of the port |
|
maximumChannelsPerDegree |
Direct Mapping |
Optional |
MIB parameter tnPowerMgmtPortMaxChannels |
|
minAddChannelPower |
Direct Mapping |
Optional |
MIB parameter tnIroadmPortConfigAddMinChannelPower |
|
minAttenuation |
Direct Mapping |
Optional |
MIB parameter tnAmplifierHybridPortVoaMinAttenuation |
|
minExpressChannelPower |
Direct Mapping |
Optional |
MIB parameter tnIroadmPortConfigExpressMinChannelPower |
|
minGain |
Direct Mapping |
Optional |
Power min gain of the port |
|
perChannelInputPowerDeviation |
Direct Mapping |
Optional |
MIB parameter tnWaveKeyPortDefaultPowerDeviationIn |
|
perChannelOutputPower |
Direct Mapping |
Optional |
Channel output power of the port |
|
perChannelOutputPowerAdjustment |
Direct Mapping |
Optional |
MIB parameter tnIroadmPortConfigIngressOaTargetPpcAdj |
|
perChannelOutputPowerDeviation |
Direct Mapping |
Optional |
Port Default Power Deviation Out |
|
portPowerIn |
Direct Mapping |
Optional |
MIB Parameter tnAmplifierPortPowerIn |
|
powerManagementType |
Automatic, Manual |
Optional |
Power Management Port Type |
|
ramanSignalOutputPower |
Direct Mapping |
Optional |
MIB parameter tnRamanPortSignalPowerOut |
|
ramanTotalInputPower |
Direct Mapping |
Optional |
MIB parameter tnRamanPortTotalPowerIn |
|
signalOutputPower |
Direct Mapping |
Optional |
Port Signal output power |
|
spanLossDefault |
Direct Mapping |
Optional |
MIB parameter tnIroadmPortConfigNominalSpanLossOut |
|
spliceMargin |
Direct Mapping |
Optional |
Port power gain backoff |
|
targetGain |
Direct Mapping |
Optional |
MIB parameter tnRamanPortAgcTargetGain |
|
targetTilt |
Direct Mapping |
Optional |
Target tilt of the port |
|
totalInputPower |
Direct Mapping |
Optional |
Input power of the port |
|
toalOutputPower |
Direct Mapping |
Optional |
Output power of the port |
|
voaSet |
Direct Mapping |
Optional |
MIB parameter tnAmplifierPortVoaSet tnIroadmPortConfigVoaSet tnAmplifierMeshCardVoaSet |
The GET /oms1350/networkinventory/xctopology request shall be used to retrieve a list of all cross connections and related data for all Network Elements stored in NFM-T.
For OCH cross connections the cross connection topology is included in the related data. Only cross connections with sncState of active shall be returned. Cross connections with sncState of local shall not be returned
No input parameters are required for this request.
The response to a GET /oms1350 oms1350/data/otn/networkinventory/xctopology request shall contain the response status and HTTP URL where the inventory data files can be accessed.
The inventory data files shall contain the attributes listed below for each port.
The attributes shall be returned as a name value pair of the format "parameter name": "parameter value" (e.g. "NEName": "NewYorkMetro").
Table 11: Response for Retrieve Cross Connection Topology
Attribute Name |
Valid Values |
Mandatory/ Optional | Description |
---|---|---|---|
userLabel |
0-60 characters |
Mandatory |
tnOchXcItuName |
direction |
unidirectional, bidirectional |
Mandatory |
tnOchXcItuBidirectional |
rate |
OCH, ODU0, ODU1, ODU2, ODU2e, ODU3, ODU3e2, ODU4, DSR |
Mandatory |
Cross Connection Rate |
sncType |
CS_SIMPLE, CS_DOUBLE_SIMPLE |
Mandatory |
Cross Connection Shape |
frequency |
Of the format 9410.000 |
Optional |
tnOchXcItuSrcChannel |
width |
50000, 62500, 75000 |
Optional |
tnOchXcItuSpectralWidth |
connectionName |
String | Optional |
Name of Connection Using the OCH XC |
sncid |
Integer |
Mandatory |
OMS XC identifier |
xcId |
Integer |
Optional |
tnOchXcItuId |
zaXcId |
Integer |
Optional |
tnOchXcItuId |
waveKeyConfiguration |
Auto, Manual, Unkeyed |
Optional |
tnOchXcItuAutoWaveKeySelect |
zaWaveKeyConfiguration |
Auto, Manual, Unkeyed |
Optional |
tnOchXcItuAutoWaveKeySelect |
azWaveKey1 |
Integer |
Optional |
tnOchXcItuEncodedWaveKey1AZ |
azWaveKey2 |
Integer |
Optional |
tnOchXcItuEncodedWaveKey2AZ |
zaWaveKey1 |
Integer |
Optional |
tnOchXcItuEncodedWaveKey1ZA |
zaWaveKey2 |
Integer |
Optional |
tnOchXcItuEncodedWaveKey2ZA |
waveKeyingPref |
NA, None, DupsOK, NoDups |
Optional |
tnOchXcItuWaveKeySelectPreference |
zawaveKeyingPref |
NA, None, DupsOK, NoDups |
Optional |
tnOchXcItuWaveKeySelectPreference |
azDupsUnlocked |
NotReceived, Yes, No |
Optional |
tnOchXcItuWaveKeyDupsUnlockedAZ |
zaDupsUnlocked |
NotReceived, Yes, No |
Optional |
tnOchXcItuWaveKeyDupsUnlockedAZ |
attributeNameValue |
Optional |
additional info about the cross connection |
|
azTopology |
Optional |
Header For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction. |
|
order |
Integer in the range 0-100 |
Optional |
Increment in the range 0-100 |
PortName |
Port AID e.g. ALPHG-<shelf>-<slot>-<port> |
Optional |
Name of the port |
zaTopology |
Optional |
Header For OCH cross connections. This section is the list of ports the cross connection traverses across the NE in the AZ direction. |
|
order |
Integer in the range 0-100 |
Optional |
Increment in the range 0-100 |
PortName |
Port AID e.g. ALPHG-<shelf>-<slot>-<port> |
Optional |
Name of the port |
A1 End |
Mandatory |
Header |
|
PortName |
See Reference [2]for Valid Values |
Mandatory |
NE Name |
NEName |
NE TID |
Mandatory |
Port AID |
Z1 End |
Mandatory |
Header |
|
PortName |
See Reference [2]for Valid Values |
Mandatory |
NE Name |
NEName |
NE TID |
Mandatory |
Port AID |
A2 End |
Mandatory |
Header |
|
PortName |
See Reference [2]for Valid Values |
Mandatory |
NE Name |
NEName |
NE TID |
Mandatory |
Port AID |
Z2 End |
Mandatory |
Header |
|
PortName |
See Reference [2]for Valid Values |
Mandatory |
NE Name |
NEName |
NE TID |
Mandatory |
Port AID |