Nokia Network Services Platform (NSP) Adapter

General information

The Nokia NSP adapter is an IP adapter that supports the discovery of inventory, topology, IGP-ISIS, TE-Topology-ISIS, L3-Topology (P2P Link, Broadcast Link), RSVP-TE, SR-TE, L2VPN, and L3VPN services.

In all of the above, the adapter uses the raw data received from the NSP controller through REST API to collect the relevant data.

The adpter introduces support for Fully Qualified Domain Name (FQDN) for discovery, notifications and stats collections.

Note that Crosswork Hierarchical Controller supports provisioning of L2VPN and L3VPN for Nokia NSP. Provisioning is provided by the NSO engine, which is embedded in Crosswork Hierarchical Controller. For more information, refer to the Cisco Crosswork Hierarchical Controller 8.0 Service Provisioning User Guide.

 

APIs used

The following list comprises the APIs utilized by the IP adapter.

Table 1.Network Discovery Details for the Nokia NSP Adapter

Discovery Type

Discovery Item

HTTP Requests/API

HTTP Method

Inventory

Network-Elements

/restconf/data/nsp-equipment:network/network-element?depth=2

GET

 

Shelf

/restconf/data/nsp-equipment:network/network-element/hardware-component/shelf

GET

 

Cards

/restconf/data/nsp-equipment:network/network-element/hardware-component/card

GET

 

Fans

/restconf/data/nsp-equipment:network/network-element/hardware-component/fan

GET

 

Power Supply

/restconf/data/nsp-equipment:network/network-element/hardware-component/power-supply

GET

 

Ports

/restconf/data/nsp-equipment:network/network-element/hardware-component/port

GET

Topology

Physical Links

/NetworkSupervision/rest/api/v1/physicalLinks

GET

 

Lag Ports

/restconf/data/nsp-equipment:/network/network-element/lag

GET

 

Logical Ports

/restconf/operations/nsp-inventory:find

Body:

{"input": {"xpath-filter": "/nsp-network:network/node[node-id='a.b.c.d']/node-root/openconfig-interfaces:interfaces/interface/subinterfaces/subinterface

", "fields": "config;state;openconfig-if-ip:ipv4/addresses/address

"}}

POST

 

Isis Topology

/restconf/data/ietf-network:networks/network

GET

 

L3 Topology

/sdn/api/v4/nsp/net/l3/networks

GET

 

TE Tunnels

/restconf/data/ietf-te:te/tunnels/tunnel

GET

 

TE Tunnels (per tunnel)

/restconf/data/ietf-te:te/tunnels/tunnel/tunnel={0}

GET

 

RSVP LSP Paths

/sdn/api/v4/mpls/lsp-paths?pathType=RSVP

GET

 

SRTE LSP Paths

/sdn/api/v4/mpls/lsp-paths?pathType=SRTE

GET

Service Discovery

L2VPN Service

/restconf/data/ietf-l2vpn-ntw:l2vpn-ntw/vpn-services/vpn-service

GET

 

L2VPN service (per service)

/restconf/data/ietf-l2vpn-ntw:l2vpn-ntw/vpn-services/vpn-service={0}

GET

 

L3VPN services

/restconf/data/ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service

GET

 

L3VPN services (per service)

/restconf/data/ietf-l3vpn-ntw:l3vpn-ntw/vpn-services/vpn-service={0}

GET

Statistics

Get Subscription

/restconf/data/md-subscription:/subscriptions/subscription={0}

GET

 

Create Subscription

/restconf/data/md-subscription:/subscriptions/subscription={0}

 

Body:

{

"name": "subscription_name",
 "description": "subscription_description",
 "period": 30,
 "sync-time": "00:00",
 "state": "enabled",
 "type": <kpi_type>,
 "notification": "enabled",
 "db": "enabled"

}

 

KPI-Types Used:

PHY_PORTS :"telemetry:/base/sros-port/port_statistics”,
 AGG_PORTS: "telemetry:/base/sros-lag/lag_statistics”,
 LGC_PORTS: "telemetry:/base/sros-router/router_interface_statistics”,
 LSP: LINKS: "telemetry:/base/lsps/lsp-egress"

POST

Token Management

Create Token

/rest-gateway/rest/api/v1/auth/token

 

Body:

{"grant_type": "client_credentials"}

POST

 

Refresh Token

/rest-gateway/rest/api/v1/auth/token

 

Body:

{"grant_type": "refresh_token", "refresh_token": <token>"}

POST

 

Revoke Token

rest-gateway/rest/api/v1/auth/revocation

 

Body:

{"token": <token-to-revoked>, "token_type_hint": "token"}

POST

 

Version Support

The following table lists the tested devices and their versions supported on the Nokia NSP adapter.

Table 2.Versions Supported by the Nokia NSP Adapter

Controller version 

Tested Devices 

Device Versions 

22.6

23.11

7750-SR

7750-SR-2s(TiMOS-C-20.7.R2)

7750-SR7(TiMOS-C-21.10.R2/TiMOS-C-19.10.R9)

7750-SRa8 (TiMOS-C-19.10.R9)

7750-SR12(TiMOS-C-21.10.R2)

 

Discovery

Table 3.Network Discovery Details for the Nokia NSP Adapter

Discovery and Visualization

Provisioning

Inventory

Topology

Services

PMs

Inventory ports.

Other inventory devices (power supplies, cards, fans, etc.)

IGP devices.

Router physical, Router logical,

Router aggregate, IGP ISIS, RSVP-TE, SR-TE, L2VPN, L3VPN, TE-Topology, Broadcast Link FQDN.

L3VPN

L2VPN (E-Lines: EVPN, TLDP, Multipoint EVPN services).

Physical Ports, Lag Ports

Logical Ports (PACKET_IN,

PACKET_OUT,

OCTET_IN,

OCTET_OUT,

PPS_IN,

PPS_OUT,

BPS_IN,

BPS_OUT)

LSP (PACKET_OUT,

OCTET_OUT)

Other (NSO)

 

Inventory

Table 4.Inventory Parameter Details for the Nokia NSP Adapter

Parameter

Card

Fan Tray

IGP Device

Port

Power Supply

Router

access_identifier

Yes

Yes

Populated by IGP IS-IS Persistor

 

Yes

Yes

 

card_status

Yes

 

 

 

 

 

card_type

Yes

 

 

 

 

 

children

Yes

 

 

 

 

Yes

children_ports

 

 

 

 

 

Yes

desc

Yes

Yes

 

Yes

Yes

Yes

device

Yes

Yes

 

Yes

Yes

 

device_family

 

 

Yes

 

 

Yes

device_type

 

 

 

 

 

Yes

domain_name

 

 

Yes

 

 

 

extra

Yes

Yes

 

Yes

(actual_rate, actual_rate_units,

component_id, encap_type, fdn, mode,

mtu, parent_component_id, port_index,

port_type, rate)

Yes (component_id, fdn)

Yes

equip_state

 

 

 

Yes

 

 

guid

Yes

Yes

Yes

Yes

Yes

Yes

Igp_type

 

 

Yes

 

 

 

Isis_info

 

 

Yes

 

 

 

management_ip

 

 

 

 

 

Yes

model_number

Yes

Yes

 

Yes

Yes

Yes

name

Yes

Yes

Yes

Yes

Yes

Yes

parent

Yes

Yes

Yes

Yes

Yes

Yes

part_number

Yes

Yes

 

Yes

Yes

Yes

ports

 

 

 

 

 

 

pluggability

 

 

 

Yes

 

 

provider

Yes

Yes

Yes

Yes

Yes

Yes

reachability_status

 

 

Yes

 

 

Yes

Router_id

 

 

Yes

 

 

 

serial_number

Yes

Yes

 

Yes

Yes

Yes

site

 

 

 

 

 

 

software_version

 

 

 

 

 

Yes

sr_capabilities

 

 

Yes

 

 

 

srlgs

 

 

 

 

 

 

vendor

Yes

Yes

 

Yes

Yes

Yes

supported_physical_layers

 

 

 

 

 

 

supported_speeds

 

 

 

 

 

 

tunable_type

 

 

 

 

 

 

tuned_lambda

 

 

 

 

 

 

 

 

Topology

Ports

Table 5.Port Item Attributes for the Nokia NSP Adapter

Attribute

IGP

L2VPN

L3VPN

Router
Aggregate

Router
Logical

Router Physical

UNI

Virtual
UNI

Adjacency

Fields are filled by IGP-ISIS persistor

 

 

 

 

 

 

 

admin_status

 

Yes

Yes

Yes

Yes

Yes

Yes

Yes

containing_service

 

Yes

Yes

 

 

 

Yes

Yes

desc

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

device

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

egress_bandwidth_profile

 

 

 

 

 

 

Yes

Yes

eline_specific

 

 

 

 

 

 

Yes

Yes

Eth_port_type

 

 

 

 

 

Yes

 

 

extra

 

 

 

Yes

Yes

Yes

 

Yes

(QinQ – cvlanid and svlanid)

export_rts

 

Yes

Yes

 

 

 

 

 

has_service_end_point

_capability

 

Yes

Yes

 

 

 

Yes

Yes

if_index

 

 

 

 

 

Yes

 

 

Import_rts

 

Yes

Yes

 

 

 

 

 

igp_metric

Yes

 

 

 

 

 

 

 

ingress_bandwidth_profile

 

 

 

 

 

 

Yes

Yes

is_all_to_one_bundling

 

 

 

 

 

 

Yes

 

Is_loopback

 

 

 

 

Yes

 

 

 

l_2_vpn_specific

 

 

 

 

 

 

Yes (for Multi-point EVPN ports )

Yes

l_3_vpn_specific

 

 

 

 

 

 

Yes

Yes

ip_address

Yes

 

 

 

 

 

 

 

isis_info

Yes

 

 

 

 

 

 

 

links

 

 

 

 

 

 

 

Yes

lower_ports

Yes

 

 

Yes

Yes

 

Yes

Yes

mappedCeTags

 

 

 

 

 

 

 

Yes

mtu_size

 

 

 

 

 

 

Yes

Yes

name

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Non_primary_ips

 

 

 

 

Yes

 

 

 

oper_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

parent

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Primary_ip

 

 

 

 

Yes

 

 

 

Physical_address

 

 

 

 

 

Yes

 

 

provider

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Route_distinguisher

 

Yes

Yes

 

 

 

 

 

rsvp_reserved_bandwidth_bps

 

 

 

 

Set to none

 

 

 

rsvp_static_bandwidth_bps

 

 

 

 

Set to none

 

 

 

Speed_bps

 

 

 

 

 

Yes

 

 

sr_prefix_sids

Yes

 

 

 

 

 

 

 

te_metric

Yes

 

 

 

 

 

 

 

upper_ports

 

 

 

Yes

 

 

 

 

vlan

 

 

 

 

Set to none

 

 

 

vpn_role

 

Yes

Yes

 

 

 

 

 

vrf_name

 

Yes

(VRF name will be the name of L2VPN Service)

Yes

(VRF name will be the name of L2VPN Service)

 

 

 

 

 

 

 

Links

Table 6.Link Item Attributes for the Nokia NSP Adapter

Attribute

E-Line

IGP

L2VPN

L3VPN

LSP

Pseudo Wire

Router Aggregate

Router
 Logical

Router Physical

SR Segment

active_protection_priority

E-line Persistor populates the data

Filled by IGP-ISIS Persistor

L3VPN Persistor is the provider

L3VPN Persistor is the provider

 

Adapter is the provider

Provider is CrossMapper

 

Router is the provider. In extra field, Creation_reason is set as Physical Link and Subnets

Provider is CrossMapper. In extra field, crossMapper is reported as Adjacency

Persistor populates the data

desc

Yes

 

Yes

 

Yes

 

 

 

 

Yes

extra

 

 

 

 

 

Yes

 

 

Yes

Yes

 

hold_priority

 

 

 

 

 

Yes

 

 

 

 

 

Is_bidi

Yes

Yes

 

Yes

Yes

Yes

Yes

Yes

Yes

Yes

lsp_technology

 

 

 

 

Yes

 

 

 

 

 

name

Yes

Yes

 

 

Yes

Yes

 

Yes

 

Yes

oper_status

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

path_group_type

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

paths

Yes

 

 

 

 

 

Yes

Yes

 

Yes

port_a

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

port_b

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

protection_status

 

 

 

 

 

 

 

 

 

 

provider

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

Yes

role

Yes

Yes

Yes

Yes

Yes (

Filled by Persistor

)

Yes

Yes

Yes

Yes

 

setup_priority

 

 

 

 

Yes

 

 

 

 

 

speed_bps

 

 

 

 

Yes

 

 

 

 

 

sr_adjacency_sids

 

Yes

 

 

 

 

 

 

 

 

Tx_label

 

 

 

 

Yes

 

 

 

 

 

Vc_id

 

 

 

 

Yes

 

 

 

 

 

 

Services

Table 7.Services Supported by the Nokia NSP Adapter

Type

E-Line

L2VPN

L3VPN

admin_status

Yes

Yes

Yes

any_to_any_or_hub_route_target

 

Yes

Yes

contained_ports

Yes

Yes

Yes

customer_name

Yes

Yes

Yes

deployment_state

Yes

Yes

Yes

desc

Yes

Yes

Yes

name

Yes

Yes

Yes

oper_status

Yes

Yes

Yes

provider

Yes

Yes

Yes

service_health

Yes

Yes

Yes

service_intent_relation

Yes

 

Yes

signalling_type

 

Yes

 

spoke_route_target

 

Yes

Yes

vpn_topology

 

Yes

Yes

vpn_type

 

Yes

 

 

Statistics

Statistics for devices with OS version (>=21) is supported.

Table 8.Optical Statistical Data Collected by the Nokia NSP Adapter

Type

Is Collected

Additional Information

PACKET_IN

Yes

For Physical, Aggregate and Logical Ports

PACKET_OUT

Yes

For Physical, Aggregate and Logical Ports and for LSP link

OCTET_IN

Yes

For Physical, Aggregate and Logical Ports

OCTET_OUT

Yes

For Physical, Aggregate and Logical Ports  and for LSP link

PPS_IN

Yes

For Physical, Aggregate and Logical Ports

PPS_OUT

Yes

For Physical, Aggregate and Logical Ports

BPS_IN

Yes

For Physical, Aggregate and Logical Ports

BPS_OUT

Yes

For Physical, Aggregate and Logical Ports

 

Notifications

Note:     The information below on the notification messages from Nokia NSP is restricted. This data cannot be made available for external reference or public availability. So, use of this information should follow the documentation classification guidelines of Cisco.

The Nokia NSP adapter is capable of listening to change notifications messages on the topic nsp-yang-model.change-notif. The updates are processed using the key to HCO model mapping as below:

Table 9.Mapping of HCO Objects to Nokia NSP Adapter Notification Keys

S No.

HCO Objects

Nokia NSP Notification Key

1

Network Elements

nsp-equipment:network-element

2

Shelf

nsp-equipment:shelf

3

Card

nsp-equipment:card

4

Port

nsp-equipment:port

5

Fan

nsp-equipment:fan

6

Power Supply

nsp-equipment:power-supply

7

Lag Ports

nsp-equipment:lag

8

Logical Ports

nsp-inventory:output

9

IGP- ISIS

ietf-network:network

10

TE Tunnels

ietf-te:tunnel

11

L2 VPN Service

ietf-l2vpn-ntw:vpn-service

12

L3 VPN Service

ietf-l3vpn-ntw:vpn-service

 

Provisioning

NSO is designated for provisioning tasks. Please consult the NSO documentation for comprehensive details regarding its usage and functionalities.

 

Configuration

Table 10.Configuration Parameters of the Nokia NSP Adapter

Name

Description 

Default

Adapter Properties 

 

 

Enabled

 

 

Logging Level 

 

Info

Polling Cycle [sec] 

 

3600

Server Configuration 

 

 

Host

 

 

SDN API port

 

8543

REST API port

 

8544

REST CONF API port

 

8545

Credentials key 

Credential of type HTTP

 

Connection Timeout [sec] 

 

 

Notification and Stats Configuration 

 

 

Enable Interface Stats 

 

 

Enable LSP Stats 

 

 

Enable Change notifications

 

 

Kafka Port

 

9192

Certificate Authority 

Credential of type SSH-Key

 

Enable Change notifications

 

 

Log level

 

Info

Notification Congestion Control Period [sec]

 

5

Max Notification Wait Period [sec]

 

60

Collection Parameters 

 

 

Enable Inventory Collection 

 

 

Enable Topology Collection 

 

 

Enable TE Tunnels Collection 

 

 

Enable IGP IS-IS Collection 

 

 

IGP IS-IS Priority

 

1

Enable L2/L3VPN Services Collection 

 

 

Limitations 

·       The Logical links are populated using the Logical ports only when the Sedo setting "persistor.logical.create_by_subnets" is enabled.

·       Nokia NSP adapter does not have IPv6 support.

·       IGP collection is supported only for IS-IS.

·       In Service discovery, service underlay as RSVP tunnel or SR policy is not supported as not provided by Nokia.

·       In Nokia NSP, Service oper-status field support is not complete when using IETF API.

·       Service QoS setting will include only the profile name.

·       Port Statistics for devices with OS version < 21 is not supported in this adapter.

·       Nokia NSP Notifications are partial for certain objects. Therefore, the adapter uses notifications as triggers to refresh collection via polling.

·       Provisioning use cases will use NSO.

·       The Nokia NSP adapter with HCO 8.0 is able to handle L3 Topology P2P link only, Broadcast links are not discovered by this adapter.

·       The IETF response, which provides the network-types key as “ietf-te-topology:te-topology” delivers partial data. To mitigate this, the adapter handeles the issue by not passing the data to the processing module.

·       The Nokia NSP adapter with HCO 8.0 supports only discovery of Eline, L2VPN services (types: VPWS, VPWS_EVPN, VPLS and MPLS_EVPN) and L3VPN services. Discovery of services with other service types is not supported.

·       The service endpoints with priority-tagged, dot1q and qinq are supported. Untagged encapsulation type is not supported.