Nokia NRC-T Adapters
Available Languages
Nokia NRC-T Adapter
General
Information
The Nokia NRC-T adapter
is an optical adapter that supports discovery of inventory and topology of
optical layers and PM statistics. Notification is supported for this adapter. The
adapter collects the data from the Nokia NRC-T controller using the TAPI
interface, before pushing the data to the Crosswork
Hierarchical Controller model.
Prerequisites
For the adapter to
function optimally, the adapter must access the Nokia NRC-T server.
Version Support
The following table lists the tested devices, and their versions supported on the Nokia NRC-T adapter.
Table 1. Versions Supported by the Nokia NRC-T Adapter
|
Nokia NRC-T/TAPI Version |
Tested Devices |
Device Version |
|
R22.6/TAPI 2.1.3 |
1830PSS-PHN 1830PSIM |
1830 PSS R14.0.8 1830 PSI-M R6.0.8 |
Table 2. Network Discovery Details for the Nokia NRC-T Adapter
|
Discovery and Visualization |
Provisioning |
|||
|
Inventory |
Topology |
Services |
PMs |
|
|
Optical Devices (ROADM, Non-ROADM) Shelf, Fan Tray, Cards, Physical Ports, Optical Ports, Transceivers |
OTS, OMS Links OCH, OTU, ODU Optical Tunnel Connections |
ETH Link |
Supported |
Not Supported |
Table 3. APIs Used by the Nokia NRC-T Adapter
|
Discovery
Type |
Item |
HTTP
Requests |
HTTP Method |
Comments |
|
Authentication |
Token |
/rest-gateway/rest/api/v1/auth/token/ |
POST |
|
|
Inventory |
ONE, Shelf, Card, Port, Fan, Transceivers, Links (OTS, OMS), Connections (OCH, OTU, ODU, ETH) |
/tapi/data/tapi-common:context/ |
GET |
Full network details are returned in this response. |
|
LLDP/All Physical Ports |
/oms1350/data/otn/networkinventory/allphysicalports |
GET |
This data is collected from NFMT. This command returns the
JSON file location. Use the GET operation on the JSON URL to retrieve data. |
|
|
LLDP/GET All Physical Ports JSON |
/data_report/data_extraction/npt/inventory/allphysicalports/physicalports.json |
GET |
|
|
|
Notification |
Get subscription uuid |
/tapi/data/tapi-common:context/tapi-notification:notification-context/notif-subscription/ |
POST |
|
|
Establish
subscription channel |
/tapi/data/context/notification-context/notif-subscription/sse/{uuid} |
GET |
|
|
|
Delete
subscription uuid |
/tapi/data/tapi-common:context/tapi-notification:notification-context/notif-subscription={uuid}/ |
DELETE |
|
|
|
Stats |
Get
PMs |
sftp://<SFTP server IP> /*.csv |
SFTP
PULL |
PM
files are pulled from the sftp location. |
Discovery
Inventory
Table 4. Inventory Item Attributes and Accessibility Details for the Nokia NRC-T Adapter
|
Attribute |
ONE (Optical Network Element) |
Card |
Port |
Shelf |
Mux |
Fan |
|
access_identifier |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
card_status |
No |
Yes |
No |
No |
No |
No |
|
card_type |
No |
Yes |
No |
No |
No |
No |
|
children |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
|
children_ports |
Yes |
Yes |
No |
Yes |
No |
No |
|
desc |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
|
device |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
|
device_family |
Yes |
No |
No |
No |
No |
No |
|
device_type |
Yes |
No |
No |
No |
No |
No |
|
equip_state |
No |
No |
Yes |
No |
Yes |
No |
|
extra |
Yes |
Yes |
No |
Yes |
Yes |
Yes |
|
form_factor |
No |
No |
No |
No |
No |
No |
|
guid |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
has_roadm |
Yes |
No |
No |
No |
No |
No |
|
management_ip |
Yes |
No |
No |
No |
No |
No |
|
model_number |
No |
No |
No |
No |
No |
No |
|
name |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
oui |
No |
No |
No |
No |
No |
No |
|
parent |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
|
part_number |
No |
Yes |
No |
No |
No |
No |
|
pluggability |
No |
No |
Yes |
No |
No |
No |
|
ports |
No |
No |
No |
No |
No |
No |
|
provider |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
reachability_status |
Yes |
No |
No |
No |
No |
No |
|
serial_number |
No |
Yes |
No |
No |
No |
Yes |
|
site |
No |
No |
No |
No |
No |
No |
|
software_version |
No |
No |
No |
No |
No |
No |
|
srlgs |
No |
No |
No |
No |
No |
No |
|
supported_lambdas |
No |
No |
No |
No |
No |
No |
|
supported_physical_layers |
No |
No |
No |
No |
No |
No |
|
supported_reacability_meters |
No |
No |
No |
No |
No |
No |
|
supported_speeds |
No |
No |
No |
No |
No |
No |
|
tags |
No |
No |
No |
No |
No |
No |
|
topology_id |
No |
No |
No |
No |
No |
No |
|
tunable_type |
No |
No |
Yes |
No |
No |
No |
|
tuned_lambda |
No |
No |
No |
No |
No |
No |
|
type |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
vendor |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Ports
Table 5. Port Item Attributes and Accessibility Details for the Nokia NRC-T Adapter
|
Attribute |
OTS |
OMS |
OCH |
OTU |
ODU |
OpticalClient |
ETH |
Comments |
|
adjacency |
No |
No |
No |
No |
No |
No |
No |
|
|
admin_groups |
No |
No |
No |
No |
No |
No |
No |
|
|
admin_status |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
child_role |
No |
No |
No |
No |
No |
No |
No |
|
|
containing_service |
No |
No |
Yes |
No |
No |
No |
No |
|
|
desc |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
device |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
eth_type |
No |
No |
No |
No |
No |
No |
Yes |
|
|
expected_transmit_power_range |
No |
No |
No |
No |
No |
No |
No |
|
|
extra |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
guid |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
has_service_end_point_capability |
No |
No |
No |
No |
No |
No |
No |
|
|
if_index |
No |
No |
No |
No |
No |
No |
No |
|
|
links |
No |
No |
No |
No |
No |
No |
No |
|
|
lower_ports |
No |
Yes |
Yes |
Yes |
Yes |
No |
Yes |
|
|
name |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
odu_type |
No |
No |
No |
No |
Yes |
No |
No |
|
|
oper_status |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
otu_type |
No |
No |
No |
Yes |
No |
No |
No |
|
|
Parent |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
provider |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
selected_spectrum |
No |
No |
No |
No |
No |
No |
No |
|
|
span_loss |
No |
No |
No |
No |
No |
No |
Yes |
|
|
speed_bps |
No |
No |
No |
No |
No |
No |
Yes |
|
|
supported_spectrums |
No |
No |
No |
No |
No |
No |
No |
|
|
srlgs |
No |
No |
No |
No |
No |
No |
No |
|
|
tags |
No |
No |
No |
No |
Yes |
No |
No |
|
|
upper_ports |
Yes |
Yes |
Yes |
Yes |
Yes |
No |
No |
|
Links
Table 6. Link Item Attributes and Accessibility Details for the Nokia NRC-T Adapter
|
Attribute |
OTS |
OMS |
OCH |
OTU |
ODU |
ETH |
Comments |
|
active_protection_priority |
No |
No |
No |
No |
No |
No |
|
|
desc |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
distance_meters |
No |
No |
No |
No |
No |
No |
|
|
extra |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
guid |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
inverse_link_id |
No |
No |
No |
No |
No |
No |
|
|
is_bidi |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
latency_micros |
yes |
yes |
Yes |
Yes |
Yes |
Yes |
|
|
name |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
oper_status |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
path_group_type |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
paths |
No |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
port_a |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
port_b |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
protection_status |
No |
No |
No |
No |
No |
No |
|
|
provider |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
role |
Yes |
Yes |
Yes |
Yes |
Yes |
Yes |
|
|
srlgs |
No |
No |
No |
No |
No |
No |
|
|
tags |
No |
No |
No |
No |
No |
No |
|
|
te_metric |
No |
No |
No |
No |
No |
No |
|
|
used_by_hops |
No |
No |
No |
No |
No |
No |
|
Statistics
Table 7. Optical Statistics Data Collected by the Nokia NRC-T Adapter
|
Name |
Is
Collected |
Additional Information |
|
PACKET_IN |
Yes |
Ethernet Port |
|
PACKET_OUT |
Yes |
Ethernet Port |
|
OCTET_IN |
Yes |
Ethernet Port |
|
OCTET_OUT |
Yes |
Ethernet Port |
Notifications
The Nokia NRC-T adapter can listen to change notifications messages. The notification operations include OBJECT_CREATION, ATTRIBUTE_VALUE_CHANGE, and OBJECT_DELETION.
The Nokia NRC-T Adapter notification “target-object-type” keys are TOPOLOGY, NODE, NODE_EDGE_POINT, LINK, DEVICE, EQUIPMENT, ACCESS_PORT, SERVICE_INTERFACE_POINT, CONNECTION, CONNECTION_END_POINT, and CONNECTIVITY_SERVICE.
Configuration
Table 8. Configuration Parameters for the Nokia NCR-T Adapter
|
Table 9.
Name |
Description |
Default |
Range/Note |
|
Adapter Properties |
|
|
|
|
Enabled |
Enable/disable the adapter. |
False |
Enable this option once you are
ready to run the adapter. |
|
Logging Level |
The logging level at which the
discovery cycle is reported in the adapter log. |
INFO |
DEBUG, INFO, WARNING, ERROR,
CRITICAL |
|
Topology Data Fetch Interval [sec] |
Fetch topology data every X seconds.
|
3600 |
Min: 0 |
|
Minimal interval between data
updates [sec] |
The minimum time between data
updates. This is the period, for example 30 seconds, during which notifications
are stored in the local adapter cache, after which discovery runs on the cache.
If this is set to 0 seconds (default) the
discovery runs immediately. |
0 |
Min: 0 |
|
Full Data Fetch Interval [sec] |
Fetch data every X seconds. The
default is once a day. |
86400 |
Min: 0 |
|
Internal Debug |
|
False |
|
|
SSH Configuration Parameters |
General parameters regarding router
communication, as well as tunnels. |
|
|
|
Host |
IP of the tunnel. |
|
|
|
Port |
Port to be used to connect to the
tunnel. |
8543 |
|
|
NFM-T Port |
The NFM-T port. |
8443 |
|
|
CAS Port |
The CAS port. |
443 |
|
|
Timeout |
Timeout to connect to the router. |
30 |
|
|
Credentials |
The credentials to use with the
router (SSH credentials). |
|
|
|
Notifications Configuration |
Used. |
|
|
|
Enabled |
Should the notifications listener be
initialized or not? |
False |
|
|
Log_notifications |
Whether to log the notifications. |
True |
|
|
Log_level |
The logging level at which the
notifications are logged. |
INFO |
DEBUG, INFO, WARNING, ERROR,
CRITICAL |
|
Congestion_control_period_sec |
The congestion control period (CCP)
is the maximum gap allowed between two successive notifications before the
adapter begins to process the notifications queue. This ensures that all
notifications related to a particular network event are handled at the same
time. For example, an interface down notification is usually followed by a
link down notifications. Once the CCP period has passed with no further
notifications, the adapter initiates a collect cycle and consequently
processes the notification queue. This parameter is used in
conjunction with the max wait period (MWP). |
5 |
|
|
Max_notification_wait_period_sec |
If notifications are received
continuously at a frequency that is <= the congestion control period
(CCP), then irrespective of the gap between two notifications, if the time
elapsed since the first notification is greater than the MWP, the queue is processed
immediately. |
60 |
|
|
Notification_silent_period_sec |
notification channel will reset after this period if no notification received |
3600 |
|
|
File bringer Configuration |
Used to feed the adapter with local
collection files instead of polling the routers directly. |
|
|
|
Enabled |
Should the File Bringer (FB) be
enabled or not. If the FB is enabled, the adapter
ignores the server’s configuration and tries to fetch static files using the
FB configuration. These files must be provided by
another service. |
False |
|
|
Remote address with file pattern |
SFTP or a file folder on your
machine and the file pattern. |
|
^((ftp|sftp|file):\\/\\/(([^\\/:]+)(:(\\d+))?)?(\\/?[^:]+))|\\s*$ |
|
Credentials |
The SSH_KEY or SFTP credentials. |
|
|
|
PM Configuration |
General parameters regarding
performance metrics. |
|
|
|
Enabled |
Whether to collect performance
metrics. |
False |
|
|
PM Data Fetch Interval [sec] |
Fetch PM data every X seconds. |
1800 |
|
|
Add_15mins_stats |
Fetch 15 minute
PM data. |
True |
|
|
Add_24hrs_stats |
Fetch 24 hour
PM data. |
True |
|
|
Remote address with file pattern |
SFTP or a file folder on your
machine and the file pattern. |
|
^((ftp|sftp|file):\\/\\/(([^\\/:]+)(:(\\d+))?)?(\\/?[^:]+))|\\s*$ |
|
Credentials |
The SSH_KEY or SFTP credentials. |
|
|
|
Optional Customization |
|
|
|
|
ILA node name RE pattern to match |
ILA node name RE pattern to match |
|
String |
|
ROADM node name RE pattern to match |
ROADM node name RE pattern to match |
|
String |
|
OSS OMS link name RE pattern to
match from OTS link names |
OSS OMS link name RE pattern to
match from OTS link names |
^(.*/.*/OMS/\d+)/.*$ |
String |
FeedbackContact Cisco
- Open a Support Case
- (Requires a Cisco Service Contract)