Cisco Optical Network Planner Configuration Guide, Releases 26.x.x

PDF

Export device NETCONF XML file for NCS 1010 networks

Updated: March 10, 2026

Want to summarize with AI?

Log in

Overview

Teaches you how to export device NETCONF XML file for NCS 1010 networks. Instructs you on the necessary steps to perform this task effectively and ensure proper network configuration.

Use this procedure to export the NETCONF XML files for all network sites or the entire network from the Cisco ONP GUI. This supports device configuration, automation, and network provisioning using the latest supported parameters.

Note

NETCONF device XML is not supported for NCS1004 and NCS1014 devices.

The network must be in Analyze mode.

Before you begin

Log in to the Cisco ONP web interface.
Table 1. Feature History

Feature Name

Release Information

Feature Description

Export Device and Cisco Optical Site Manager NETCONF XML file for all NCS 1000 networks

 Cisco ONP Release 26.1.1

The NETCONF XML file exported for the analyzed NCS 1000 network designs now include this parameter when the config mode, card type, and client type are configured.

  • mode

NCS 1010 designs now include these parameters.

Parameters based on Enable Special Settings:

  • Patchcord Loss Threshold (applicable for C+L band device)

  • Ots Rx Low Threshold (applicable for C+L Raman device)

  • Bidirectional span-loss mismatch threshold

  • Payload OSC Min Deviation

  • Payload OSC Max Deviation

Parameters based on Raman LUT and ALC2 and LUT:

  • Raman-tuning with-payload

  • Raman-turn-up <enable/disable>

  • Raman-safety-trigger dfb-los

  • Raman-safety-trigger osc-los

  • Raman-safety-trigger osc-osnr-los
Table 2. Feature History

Feature Name

Release Information

Feature Description

ALC2 Enhancements

 Cisco ONP Release 25.1.1

The NETCONF XML file exported for the analyzed NCS 1010 network design with Microsoft configuration now includes a new parameter.

  • OTDR-ScanMode-Expert

If you enable the Enable Special Settings check box under Network level properties, the generated XML file contains the OTDR-ScanMode-Expert parameter that is set to multi-region.

If you do not enable the Enable Special Settings check box, then the scan mode configuration is not added to the device Netconf XML file.
Table 3. Feature History

Feature Name

Release Information

Feature Description

New Parameters Included in NCS 1010 NETCONF XML file

Cisco ONP Release 24.3.1

The NETCONF XML file exported from the NCS 1010 network design now includes these new parameters to support seamless Day-0 provisioning and the setup of a new node added to the network.

  • Optical cross-connects

  • Gain range margin

  • Tone Rates

  • Raman tuning configurations

  • Slot reserve

  • Dmux WSS attenuation

  • Unused CCMD-16 ports shutdown

  • Span baseline-deviation

  • OTDR Thresholds

  • APC Span-loss correction threshold
Table 4. Feature History

Feature Name

Release Information

Feature Description

Export NETCONF File from NCS 1010 network

Cisco ONP Release 5.0

You can export the NETCONF XML files for all the NCS 1010 nodes, and upload them to the NCS 1010 nodes through the YANG suite. This enables automatic bring up of the NCS 1010 nodes using the NETCONF data.

Procedure

1.

In the network tree panel, click the three dots.

A pop-up list appears.
2.

In the list, click Generate Device NetConf XML.

The Export window appears displaying the network name.
3.

Click Export.

The message "Success. Device NetConf exported successfully" appears.

You can download a zip file that contains the NETCONF XML files for individual sites.

Note

You can choose the destination folder for saving the downloaded NETCONF XML files of individual sites.

This feature has limited scope in this release.

Note

For C+L Network, the partner band configurations are not included in the Cisco ONP-generated XML file. Manually configure the partner bands on the devices while bringing up the NCS 1010 C+L network.

Note

NETCONF device XML is not supported for NCS1004 and NCS1014 device.

From Release 24.3.1, these new parameters are available in the NETCONF file exported from the NCS 1010 network design:

  • OSC TX Power

  • Optical Cross Connect

  • OTS tone rate

  • OMS tone rate

  • OTS tone pattern expected

  • OTS tone detect OOB

  • OTS tone pattern

  • OTS tone frequency

  • Raman pump configurations

  • Line port attenuation

  • Raman dual safety

These parameters are available only if you enable the Enable Special Settings check box under the Network properties.

  • Raman turnup

  • OTS ports shutdown

  • OTDR autoscan

  • Gain range margin

  • OTDR excess attenuation threshold

  • OTDR end of fiber threshold

  • Slot reserve

  • Dmux WSS attenuation

  • Unused CCMD-16 ports shutdown

  • Span baseline-deviation

  • OTDR Thresholds

  • APC Span-loss correction threshold

  • OTDR-ScanMode-Expert

Note

From R25.1.1, the Cisco ONP-generated XML file for the analyzed NCS 1010 networks include the OTDR-ScanMode-Expert value. The value is set to

  • multi-region if you enabled the Enable Special Settings check box.

  • auto if you did not enable the Enable Special Settings check box.

From Release 26.1.1, these new parameters are available in the NETCONF file exported from the NCS 1010 network design. These parameters are available only if you enable the Enable Special Settings check box under the Network properties.

  • Patchcord Loss Threshold (applicable for C+L band device)

  • Ots Rx Low Threshold (applicable for C+L Raman device)

  • Bidirectional span-loss mismatch threshold

  • Payload OSC Min Deviation

  • Payload OSC Max Deviation

Parameters based on Raman LUT and ALC2 and LUT:

  • Raman-tuning with-payload

  • Raman-tuning manual

  • Raman-tuning Raman-gain-target

  • Raman-turn-up <enable/disable>

  • Raman-safety-trigger dfb-los

  • Raman-safety-trigger osc-los

  • Raman-safety-trigger osc-osnr-los

  • Raman Pump Configuration such as Raman-tx-power-instance and Raman-tx-power-value

Export device NETCONF XML Files for individual sites

Use this procedure to export device NETCONF XML files for individual sites from the Cisco ONP GUI.

Before you begin

Log in to the Cisco ONP web interface.

Procedure

1.

Click the Ellipsis icon next to the site.
2.

In the list, click Generate Device NetConf XML.

Export window appears with network name.
3.

Click Export.

The message, "Success. Device NetConf exported successfully" appears.

You can download a zip file containing device NETCONF XML files of individual sites.

Upload NETCONF files to NCS 1010 device using NETCONF client

Use this procedure to upload the NETCONF files that you downloaded from Cisco ONP, into the NCS 1010 device using a NETCONF client.

Before you begin

Log in to the Cisco ONP web interface.

Procedure

1.

Log in to the YANG suite that has access to the NCS 1010 device.
2.

Connect to the NCS 1010 device.
3.

Copy the NETCONF XML file content that is downloaded from Cisco ONP, and paste it into the Protocol NETCONF Run RPC block.
4.

Append this commit code at the end of the NETCONF XML file content.

<rpc xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="102">
<commit/>
</rpc>

Export Cisco Optical Site Manager NETCONF XML file for NCS 1001/1010/1014 networks

Use this procedure to export the Cisco Optical Site Manager NETCONF XML files for all the individual sites in a network, from the Cisco ONP GUI.

Table 5. Feature History

Feature Name

Release Information

Feature Description

Export Device and Cisco Optical Site Manager NETCONF XML file for all NCS 1000 networks

 Cisco ONP Release 26.1.1

Cisco Optical Site Manager XML supports NCS 1001 and NCS 1014 networks. NCS 1004 configurations are added to the XML file.

NCS 1010 designs now include these parameters.

Parameters based on Raman LUT and ALC2 and LUT:

  • Raman-tuning manual

  • Raman-tuning Raman-gain-target

  • Raman Pump Configuration such as Raman-tx-power-instance and Raman-tx-power-value

Table 6. Feature History

Feature Name

Release Information

Feature Description

Export Cisco Optical Site Manager (COSM) NETCONF File from NCS 1010 network

Cisco ONP Release 5.2

The new Generate COSM NetConf XML option allows you to export from the Cisco Optical Network Planner, the Cisco Optical Site Manager NETCONF XML files for all the NCS 1010 nodes. You can then upload these files to the NCS 1010 nodes through the Cisco Optical Site Manager, enabling automatic bring-up of the NCS 1010 nodes.

This feature has limited scope in this release.

The network must be in Analyze mode.

Note

From R26.1.1, export of COSM XML for NCS 1001 and NCS 1014 platforms are supported with these limitations.

  • Analysed NCS1001 and NCS1014 networks in R25.1.1 must be reanalysed in R26.1.1 before generating Cisco Optical Site Manager XML for NCS 1001 and NCS 1014 networks.

  • Cisco Optical Site Manager XML is not supported for NCS 1001 networks with PSM-Path protection configuration.

Procedure

1.

In the network tree panel, click the three dots.

A pop-up list appears.
2.

In the list, click Generate COSM NetConf XML.

Export window appears with network name.
3.

Click Export.

The message "Success. COSM NetConf exported successfully" appears.

Download the zip file that contains the COSM NETCONF XML files of individual sites.

Note

You can choose the destination folder to save the downloaded Cisco Optical Site Manager NETCONF XML files of individual sites.

Note

  • For the ROADM OLT node, the device name is generated in the Site Name-Side Name format.

  • For the OLA node, the device name is the same as the Site Name.

Ensure that you align the device name in COSM to match the specified format.

If the Site Name contains any special character, the XML file replaces the special character with its ASCII value in the COSM XML device name, providing a seamless experience with the COSM data backup workflow.

Note

L-Band Configuration is not certified in Cisco Optical Site Manager XML. A future release will be considered for the L-Band configuration.

Note

From R26.1.1, the Cisco ONP-generated XML file for the analyzed NCS 1000 networks include the Mode value. The value is set to

  • MXP-1K if you set Config Mode as Muxponder or Bundle.

  • MXP-SLICES-1K if you set Config Mode as Slice.

This value appears only when you set the Card Type, Config Mode, and Client Type properties.

Upload a NETCONF XML to NCS 1010 device through COSM web interface

Use this procedure to upload Cisco Optical Site Manager NETCONF XML files, generated by the Cisco ONP, to an NCS 1010 device using the Cisco Optical Site Manager web interface.

Before you begin

  • Download the required COSM NETCONF XML files for the target NCS 1010 device. If you want to configure cross connects, download two files:

    • one without optical cross connect (OXC)

    • and one with optical cross connect (OXC).

  • If the devices are already onboarded on COSM, verify that the device name and unique identifier (UID) in COSM are identical to those in the COSM generated XML files. If the device name or UID does not match, remove the device from the interface. Alternatively, update the device name, UID, and rack position in the XML to align with COSM and then upload the updated file.

  • If the devices are not onboarded on COSM, upload the COSM XML without onboarding the devices. The device name and UIDs configured in the XML file will be assigned during device onboarding.

Procedure

1.

Log in to the Cisco Optical Site Manager UI that has access to the NCS 1010 device.
2.

Click Optical Setup in the left panel.
3.

Click the Node Setup tab.

4.

Click Select an XML configuration file.

  1. Navigate to the location where the COSM XML file without OXC is present and select it.

  2. Click Yes.

  3. Click Upload.

    A confirmation message appears after the upload is complete.

Manually configure the IP address details of the device, as they are not part of the COSM XML file generated through Cisco ONP.
5.

Create an authorization group for the device added through the imported XML.

  1. Click Devices in the left panel.

  2. In the Devices tab, click the Authorization Group section to expand it.

  3. Click the Add Auth Group button.

  4. In the Add Authorization Group dialog box, enter the Auth Group Name, Remote User Name, and Remote Password in their respective fields.

  5. Click Add

    The new auth group is added to the table.
6.

Edit the device details:

  1. In the Devices tab, click the Devices section to expand it.

  2. Select the device and update its IP Address and Auth Group.

  3. Click Apply.

  4. Wait until Sync Status to shows sync-completed, and alarm-synchronized.
7.

Go to Optical Configuration > ANS parameter and verify whether the respective configurations are complete.
8.

After you load the Cisco Optical Site Manager XML file without optical cross connect, load the file with optical cross connect and edit the device details.
9.

After adding the Cisco Optical Site Manager XML file with optical cross connect, go to the Optical Cross Connections tab and verify whether the respective configurations are complete.
Both COSM XML files (without and with OXC) are successfully uploaded to the NCS 1010 device, and device configurations are updated according to the planned parameters.