Introduction
This document outlines the process for downloading, installing, and configuring the Cisco Crosswork Change Automation (CA) function pack on Cisco Network Services Orchestrator (NSO). It also details the necessary configurations within Cisco Crosswork for Change Automation.
Purpose: This guide covers the installation of the nca-7.0.3-nso-6.1.16.3.20250509.dbe70d0.tar.gz
function pack on Cisco NSO 6.1.16.3, including associated configurations. It also addresses authgroup
configurations for creating unique usermaps (umap
) for Change Automation and DLM configurations with Change Automation application settings in Cisco Crosswork 7.0.2.
Pre-requisites: The document specifies minimum compatible versions: Cisco NSO v6.1.16.3 and Cisco Crosswork v7.0.2.
Installing/Upgrade Function Pack
The guide provides step-by-step instructions for installing the cw-device-auth
function pack on Cisco NSO 6.1.11.2 or higher. This includes downloading the package, placing it in the repository, reloading packages via NCS CLI, and verifying the installation.
Creating a Special Access User in Cisco NSO
This section details the creation of a dedicated access user for Cisco NSO, separate from users used for DLM or collection services. It includes steps for creating a new sudo user (e.g., 'cwuser') on Ubuntu and adding this user to the ncsadmin
group and the nacm
group. Verification of HTTP and HTTPS access via RESTCONF API is also covered.
Adding Usermap (umap) to Cisco NSO Authgroup
Learn how to configure authgroups in Cisco NSO for southbound device access, including the use of default-maps or usermaps (umap
). The guide explains how to create a umap
for the 'crosswork' authgroup to enable the 'override credentials passthrough' feature used by Crosswork Change Automation. It also shows how to add a umap
for a newly created user like 'cwuser'.
Configuring DLM in Cisco Crosswork
After installing the function pack in NSO, this section guides users through setting up configurations in DLM within Cisco Crosswork. This enables Change Automation to access Cisco NSO using the newly created user and override credentials. It covers creating the ca_device_auth_nso
credential profile and an additional profile (e.g., 'nso-creds') for other Cisco Crosswork components, emphasizing the importance of distinct usernames for these profiles. Finally, it explains how to add the DLM Provider Property, ensuring the property key and value are set to ca_device_auth_nso
.
Troubleshooting
This section addresses common errors encountered during the installation and configuration process. It provides solutions for issues such as mismatched nso umap
users and credential profiles, empty auth group umap
, and failures in retrieving RESTCONF resource roots, ensuring proper connectivity to Cisco NSO via RESTCONF.