Cisco ONC Adapters

Available Languages

Updated:September 1, 2025

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Cisco Optical Network Controller (ONC) Adapter

General Information

The Cisco ONC adapter is an optical adapter that supports the Routed Optical Network (RON) use case, with layer 0 network inventory and topology discovery of NCS1010 as a ROADM.

The Cisco ONC adapter also supports OCH-NC (Wavelength) service provisioning, explicitly as a service between NCS1010 and implicitly as a part of RON link (ZR or ZR over NCS1010) provisioning.

·       Adapter supports collection of power level counters for all optical ports.

·       Adapter uses TAPI 2.1.3 as an interface to Cisco ONC.

 

Version Support

The following table lists the tested devices and their versions supported on the Cisco ONC adapter.

 

Table 1.Versions Supported by the Cisco ONC Adapter

CONC  

Tested Devices

Device Version

3.1

Cisco NCS 1010 devices

IOS-XR 7.11.1, IOS-XR 7.11.2

2.1.1

Cisco NCS 2000 devices

SVO 12.3.1

 

Discovery

Table 2.Network Discovery Details for the Cisco ONC Adapter

Discovery and Visualization

Provisioning

Inventory

Topology

Services

PMs

ROADM Devices (NCS 1010)

Chassis, Cards, Pluggables, Physical Ports.

OTS, OMS, MC and NMC (OTSiMC) Links between ROADMs and Amplifiers.

OCH-NC (Wavelength) between ROADMs

Power level PM counters on all optical ports

OCH-NC

RON link (implicit provisioning of OCH-NC)

 

Inventory

Table 3.Inventory Item Attributes and Accessibility Details for the Cisco ONC Adapter

Attribute

ONE (Optical Network Element)

Card

Port

Shelf

card_type

No

Yes

No

No

desc

No

Yes

Yes

Yes

device

No

Yes

Yes

Yes

device_family

Yes

No

No

No

device_type

Yes

No

No

No

equip_state

No

No

Yes

No

has_roadm

Yes

No

No

No

management_ip

Yes

No

No

No

name

Yes

Yes

Yes

Yes

parent

No

Yes

No

Yes

part_number

No

No

No

Yes

pluggability

No

No

Yes

No

provider

Yes

Yes

Yes

Yes

reachability_status

Yes

No

No

No

serial_number

No

Yes

Yes

Yes

vendor

Yes

Yes

Yes

No

tuned_lambda

No

No

No

Yes

 

Ports

Table 4.Port Item Attributes and Accessibility Details for the Cisco ONC Adapter

Attribute

OTS

OMS

NMC

admin_status

Yes

Yes

Yes

containing_service

No

No

Yes

desc

No

No

Yes

device

Yes

Yes

Yes

expected_transmit_power_range

No

No

Yes

lower_ports

No

Yes

Yes

name

Yes

Yes

Yes

oper_status

Yes

Yes

Yes

parent

No

Yes

Yes

provider

Yes

Yes

Yes

selected_spectrum

No

No

Yes

supported_spectrums

No

No

Yes

 

Links

 

Table 5.Link Item Attributes and Accessibility Details for the Cisco ONC Adapter

Attribute

OTS Link

OMS Link

MC Link

NMC Link

desc

Yes

Yes

Yes

Yes

name

Yes

Yes

Yes

Yes

oper_status

Yes

Yes

Yes

Yes

path_group_type

Yes

Yes

Yes

Yes

port_a

Yes

Yes

Yes

Yes

port_b

Yes

Yes

Yes

Yes

protection_status

Yes

Yes

Yes

Yes

provider

Yes

No

Yes

Yes

role

Yes

Yes

Yes

Yes

 

Provisioning

Table 6.Provisioning Details for the ONC Adapter for the Cisco ONC Adapter

Type

Is Supported

Additional Information

OCH-NC

Yes

The Cisco ONC adapter supports OCH-NC (Wavelength) service provisioning, explicitly as a service between NCS1010 and implicitly as a part of RON link (ZR or ZR over NCS1010) provisioning.

The provisioning of OCH-NC includes an option for multi-channel.

The provisioning of OCH-NC includes an option to automatically select the pluggable application code from an XML file imported by user.

 

Statistics

Table 7.Optical Statistics Data Collected by the Cisco ONC Adapter

Type 

Is Collected

AVG_RX_POWER_DBM_SCALE_100 

Yes

AVG_TX_POWER_DBM_SCALE_100 

Yes

MIN_TX_POWER_DBM_SCALE_100 

Yes

MIN_RX_POWER_DBM_SCALE_100 

Yes

MAX_TX_POWER_DBM_SCALE_100 

Yes

MAX_RX_POWER_DBM_SCALE_100 

Yes

 

Configuration

Table 8.Configuration Parameters for the Cisco ONC Adapter

Name

Description

Default

Range

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

Adapter Properties

 

 

 

Polling Cycle [sec]

Poll every X seconds.

3600

[30]

Provisioning

Enable to use this adapter instance for provisioning.

True

 

Connection Timeout [sec]

The connection timeout.

600

 [30]

Minimal interval time 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

[0]

Number of provisioning retries in case of Timeout

The number of times to retry provisioning in the event of a timeout.

3

[3:10]

Interval time between provisioning retries [sec]

The time between provisioning retries.

60

[0:90]

Save persistor request to disk?

Whether to save the persistor request to disk.

False

 

Connection Properties

 

 

 

Host (including protocol, port, and URL prefix)

(http|https)://<server>[:<port>]

Examples URL prefix: /crosswork/onc-tapi/ or /nbiservice/ or /onc-nbi-service/

 

 

Credentials

Credentials are defined in the “Credentials” tab of the Device Manager.

 

 

Notifications Configuration

 

 

 

Enabled

Should the notifications listener be initialized or not?

True

 

URL Sub-part

NETCONF or CONC_NETCONF
CONC_NETCONF for ONC version >= 2.0

CONC_NETCONF

 

Stats Collection Configuration

 

 

 

Enabled

Whether to enable/disable statistics collection.

True

 

Stats Interval Polling [sec]

Poll for statistics every X seconds.

900

 [300]

Hyperlinker Rules Configuration

 

 

 

Enabled

Whether to enable/disable the hyper linker rules. This enables you to make vendor/controller-specific objects accessible directly from the object in the Crosswork Hierarchical Controller applications such as the Network Inventory application.

False

 

HyperLinker Rules Interval Checking (sec)

The time between hyper linker rules checking.

600

 

 

Limitations

None

 

Was this Document Helpful?

FeedbackFeedback

Contact Cisco

This Document Applies to These Products