Nokia NFM-T Adapter

General Information

The Nokia NFM-T Adapter is an optical adapter that supports discovery of inventory and topology of optical layers, services and PM statistics for the Nokia WaveSuite Network Operations Center (WS-NOC) NMS. The Nokia NFM-T adapter predominantly uses REST APIs as supported by the controller. The Nokia WS-NOC uses Bulk Information Transfer (BIT) calls to get equipment, topological links, and connection inventory.

Version Support

The following table lists the tested devices, and their versions supported on the Nokia NFM-T adapter.

Table 1. Versions Supported by the Nokia NFM-T Adapter

Nokia NFM-T/TAPI Version	Tested Devices	Device Version
23.12	1830PSS	23.12

Table 2. Network Discovery Details for the Nokia NFM-T Adapter

Discovery and Visualization				Provisioning
Inventory	Topology	Services	PMs
Optical Devices (ONEs) Shelf, Cards, Fans, Power Supplies, Physical Ports, Optical Client Ports	Ports: OTS, OMS, OCH, OTU ODU, ETH, Optical Client Links: OTS, OMS, ODU, OTU, ETH, OCH	OTN Line (Client) and E-Line	Ethernet Ports: Tx/Rx Packets and Octets Optical Ports: Tx/Rx Power	Not Supported

APIs Used

Table 3. APIs Used by the Nokia NFM-T Adapter

SNo	Discovery Type	Discovery Item	HTTP Method	HTTP Requests/API	Comments
1	Inventory	One	GET	/oms1350/data/npr/nes
		Network Elements	GET	/oms1350/data/otn/networkElement/
		Equipment (Shelves, Cards, Fans, Power Supplies)	GET	/oms1350/networkinventory/equipments/	BIT Workflow
2	Topology	Physical Ports	GET	/oms1350/data/otn/networkinventory/physicalports	BIT Workflow
		Detailed Physical Ports	GET	/oms1350/data/otn/networkinventory/allphysicalports	BIT Workflow
		Connection Ports	GET	/oms1350/otn/NBI/allCTPsPerNode/{node-id}	BIT Workflow
		Floating Ports	GET	/oms1350/data/otn/networkinventory/ftps
		Connections (Links and Paths)	GET	/oms1350/data/otn/networkinventory/connections Where SERVICECONNECTION = 0	BIT Workflow
3	Services	OTN Line Services E- Line Services	GET	/oms1350/data/otn/networkinventory/connections Where SERVICECONNECTION = 1	BIT Workflow
4	Token Management	Create Token	POST	/rest-gateway/rest/api/v1/auth/token Body: {"grant_type": "client_credentials"}
		Refresh Token	POST	/rest-gateway/rest/api/v1/auth/token Body: {"grant_type": "refresh_token", "refresh_token": <token>"}
		Revoke token	POST	rest-gateway/rest/api/v1/auth/revocation Body: {"token": <token-to-revoked>, "token_type_hint": "token"}

Discovery

Inventory

Table 4. Inventory Item Attributes and Accessibility Details for the Nokia NFM-T Adapter

Attribute	ONE (Optical Network Element)	Card	Port	Shelf	Fans	Power Supply	Slot
access_identifier	Yes	Yes	No	Yes	No	No	Yes
card_status	No	yes	No	No	No	No	No
card_type	No	Yes	No	No	No	No	No
children	No	No	No	No	No	No	No
children_ports	No	No	No	No	No	No	No
desc	No	Yes	Yes	Yes	Yes	Yes	Yes
device	No	Yes	Yes	Yes	Yes	Yes	Yes
device_family	Yes	No	No	No	No	No	No
device_type	Yes	No	No	No	No	No	No
equip_state	No	No	No	No	No	No	No
extra	yes	Yes	Yes	Yes	Yes	Yes	Yes
guid	Yes	Yes	Yes	Yes	Yes	Yes	Yes
has_roadm	Yes	No	No	No	No	No	No
management_ip	Yes	No	No	No	Yes	Yes	No
model_number	No	No	No	No	No	No	Yes
name	Yes	Yes	Yes	Yes	Yes	Yes	Yes
parent	No	Yes	Yes	Yes	Yes	Yes	Yes
part_number	No	No	Yes	No	Yes	Yes	Yes
ports	No	No	No	No	No	No	No
pluggability	No	No	Yes	No	No	No	No
provider	Yes	Yes	Yes	Yes	Yes	Yes	Yes
reachability_status	Yes	No	No	No	No	No	No
serial_number	Yes	Yes	Yes	Yes	Yes	Yes	Yes
site	No	No	No	No	No	No	No
software_version	Yes	No	No	No	No	No	No
srlgs	No	No	No	No	No	No	No
tags	No	No	No	No	No	No	No
topology_id	No	No	No	No	No	No	No
vendor	Yes	Yes	Yes	Yes	Yes	Yes	Yes
supported_physical_layers	No	No	No	No	No	No	No
supported_reacability_meters	No	No	No	No	No	No	No
supported_speeds	No	No	No	No	No	No	No
tunable_type	No	No	No	No	No	No	No
tuned_lambda	No	No	Yes	No	No	No	No

Ports

Table 5. Port Item Attributes and Accessibility Details for the Nokia NFM-T Adapter

Attribute	OTU	ODU	Optical Client	ETH	OCH	OTS	OMS
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	No	No	No	No	No
desc	No	No	No	No	No	No	No
device	Yes	Yes	Yes	Yes	Yes	Yes	Yes
eth_type	No	No	No	Yes	No	No	No
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	No	No	No	No	No	No
name	Yes	Yes	Yes	Yes	Yes	Yes	Yes
oper_status	Yes	Yes	Yes	Yes	Yes	Yes	Yes
otu_type	Yes	Yes	No	No	No	No	No
parent	Yes	Yes	Yes	Yes	Yes	Yes	Yes
port_capabilities	No	No	Yes	No	No	No	No
provider	Yes	Yes	Yes	Yes	Yes	Yes	Yes
selected_spectrum	No	No	No	No	No	No	No
speed_bps	No	No	No	Yes	No	No	No
srlgs	No	No	No	No	No	No	No
supported_spectrums	No	No	No	No	No	No	No
span_loss	No	No	No	No	Yes	Yes	Yes
srlgs	No	No	No	No	No	No	No
tags	No	No	No	No	No	No	No
upper_ports	No	No	No	No	No	No	No

Links

Table 6. Link Item Attributes and Accessibility Details for the Nokia NFM-T Adapter

Attribute	OTS	OMS	ODU	OTU	OCH
desc	No	No	No	No	No
distance_meters	No	No	No	No	No
extra	Yes	Yes	Yes	Yes	Yes
inverse_link_id	No	No	No	No	No
latency_micros	No	No	No	No	No
name	Yes	Yes	Yes	Yes	Yes
oper_status	Yes	Yes	Yes	Yes	Yes
path_group_type	No	No	No	No	No
paths	Yes	Yes	Yes	Yes	Yes
port_a	Yes	Yes	Yes	Yes	Yes
port_b	Yes	Yes	Yes	Yes	Yes
protection_status	No	No	No	No	No
provider	Yes	Yes	Yes	Yes	Yes
role	No	No	No	No	No
srlgs	No	No	No	No	No
te_metric	No	No	No	No	No
used_by_hops	No	No	No	No	No

Services

Table 7. Attributes of E-Line/OTN Line Service

Service Item	E-Line Service/OTN Line Service
admin_status	Yes
contained_ports	Yes
customer_name	Yes
deployment_state	Yes
name	Yes
oper_status	Yes
provider	Yes
service_health	Yes
service_intent_relation	Yes

Statistics

Table 8. Statistical Data Collected for the Nokia NFM-T Adapter

Type	Is Collected	Additional Information
Ethernet Port
Rx/Tx Octets	Yes
Rx/TX Packets	Yes
Optical Ports
Rx/Tx Power	Yes

Configuration

Table 9. Configuration Parameters for the Nokia NFM-T Adapter

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
Polling Cycle [sec]	Poll every X seconds.	7200	Min: 0
NFM-T Server Configuration	NFM-T server information to be used for adapter connection.
Host	(http|https)://<cas server> The Central Authentication Server host. For example: https://10.133.11.10
Port	The Central Authentication Server port.	443
NMS Port	The NMS port.	443
Credentials	Credentials are defined in the “Credentials” tab of the Device Manager.
Timeout [sec]	The connection timeout.	300
Request Retries	The number of request retries.	3
Collection Parameters	Used to customize the collection of parameters that the adapter will use in a specific installation.
Enable Inventory Collection	Whether the inventory collection is enabled or disabled.	True
Enable Topology Collection	Whether the topology collection is enabled or disabled.	True
PM Configuration	General parameters regarding performance metrics.
Enabled	Whether to collect performance metrics.	True
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.

Limitations 

· The OTSig port is modeled as OCH and the OTSig Tunnel Port is modeled as ODU.

· As Nokia uses DWDM ITU Flex Grid Channels, the wavelength value cannot be determined. This parameter is not modelled in Cisco Crosswork Hierarchical Controller for OTU ports.

· OS and OPS layers are not modelled in Cisco Crosswork Hierarchical Controller.