Pack de fonctions NSO d'automatisation des changements CISCO
Caractéristiques
- Product: Cisco Crosswork Change Automation NSO Function Pack
- Version: 7.0.2
Informations sur le produit
The Cisco Crosswork Change Automation NSO Function Pack is designed to facilitate the installation, configuration, and management of Cisco Crosswork Change Automation on Cisco Network Services Orchestrator (NSO). It includes features for creating special access users, configuring DLM in Cisco Crosswork, and troubleshooting functionalities.
Introduction
Ce document décrit comment télécharger, installer et configurer le pack de fonctions Cisco Crosswork Change Automation (CA) sur Cisco Network Services Orchestrator (NSO). Il décrit également la configuration requise pour Crosswork Change Automation dans Cisco Crosswork.
But
Ce guide décrit :
- Installing the nca-7.0.3-nso-6.1.16.3.20250509.dbe70d0.tar.gz 6.1.16.3 and the associated configurations for the function pack on Cisco NSO.
- The authgroup configurations for creating a unique usermap (umap) for Change Automation.
- DLM configurations and the Change Automation application settings required in Cisco Crosswork 7.0.2
Pré-requis
The list below shows the minimum versions of the Cisco NSO and Cisco Crosswork with which the Crosswork Change Automation function pack v7.0 is compatible:
- Cisco NSO: v6.1.16.3 system install.
- Cisco Crosswork: v7.0.2
Installation/mise à niveau et configuration
Les sections ci-dessous montrent comment installer le pack de fonctions cw-device-auth sur l'installation du système Cisco NSO 6.1.11.2 ou version ultérieure.
Installation/mise à niveau du pack de fonctions
- Téléchargez le cw-device-auth v7.0.0 depuis le référentiel vers votre Cisco NSO.
- Copiez l'archive tar.gz téléchargée du pack de fonctions dans votre référentiel de packages.
Note: The package directory can be different based on the selected settings at the time of installation. For most system-installed Cisco NSO, the package directory is located at “/var/opt/ncs/packages” by default. Check the ncs.conf on your installation to find your package directory. - Launch NCS CLI and run the following commands:
- admin@nso1:~$ ncs_cli -C -u admin
- admin connected from 2003:10:11::50 using ssh on nso1
- admin@ncs# packages reload
- Verify that the package has been successfully installed once the reload is complete.
- admin@ncs# afficher les paquets paquet cw-device-auth
- paquets paquet cw-device-auth
- version du paquet 7.0.0
- description “Crosswork device authorization actions pack”
- ncs-min-version [ 6.1]
- paquet python nom-machine virtuelle cw-device-auth
- directory /var/opt/ncs/state/packages-in-use/1/cw-device-auth
- action du composant
- application python-class-name cw_device_auth.action.App
- phase de démarrage de l'application phase2
- statut d'opérateur activé
Création d'un utilisateur à accès spécial dans Cisco NSO
Cisco Crosswork Change Automation utilise un utilisateur d'accès spécial pour se connecter à Cisco NSO et effectuer toutes les modifications de configuration. Cela signifie que vous ne pouvez pas utiliser le même utilisateur que DLM ou les services de collecte pour accéder à Cisco NSO. Cette section décrit les prérequis nécessaires à la création d'un utilisateur.
Remarque : Les étapes ci-dessous supposent que Cisco NSO s'exécute sur une machine virtuelle Ubuntu. Si votre installation Cisco NSO s'exécute sur un autre système d'exploitation, veuillez modifier les étapes en conséquence.
- Créez un nouvel utilisateur sudo sur votre machine virtuelle Ubuntu. ExampCliquez ici. Les étapes ci-dessous expliquent comment créer l'utilisateur « cwuser » sur votre machine virtuelle Ubuntu. Vous pouvez choisir ce nouveau nom d'utilisateur.
root@nso:/home/admin# adduser cwuser- Adding user `cwuser’ …
- Adding new group `cwuser’ (1004) …
- Adding new user `cwuser’ (1002) with group `cwuser’ … Creating home directory `/home/cwuser’ …
- Copier files from `/etc/skel’ …
- Enter new UNIX password:
- Retapez le nouveau mot de passe UNIX :
- passwd: password updated successfully
- Changing the user information for cwuser
- Enter the new value, or press ENTER for the default
- Full Name []:
- Room Number []:
- Work Phone []:
- Home Phone []:
- Other []:
- Is the information correct? [Y/n] y
- root@nso:/home/admin# usermod -aG sudo cwuser
- root@nso:/home/admin# usermod -a -G ncsadmin cwuser
- Add cwuser to the nacm group
- Note:
The nacm rule should be configured with cwuser even though you do not have admin as a user on server. - *nacm groups groupe ncsadmin nom d'utilisateur cwuser
- nacm groups group ncsadmin
- user-name [ admin cwuser private ]
- * Les autorisations par défaut sont affichées comme ci-dessous.
- admin@ncs# afficher la configuration en cours nacm
- nacm read-default deny
- nacm write-default deny
- nacm exec-default deny
- nacm cmd-read-default refuser
- nacm cmd-exec-refuser par défaut
- Note:
- Ensure that the new user that you created has HTTP and HTTPS access to the Cisco NSO server. This can be done by using a simple RESTCONF API as shown below.
- curl -u <USERNAME>:<PASSWORD> –location –request GET ‘https://<IP>:8888/restconf/data/tailf-ncs:packages/package=cw-device-auth’ \
- –header ‘Accept: application/yang-data+json’ \
- –header ‘Content-Type: application/yang-data+json’ \
- –données brutes »
- En appelant le curl Si vous avez exécuté la commande ci-dessus, vous devriez recevoir la réponse ci-dessous. Toute autre réponse indiquerait qu'un ou plusieurs paramètres précédents ne fonctionnaient pas.
- {
- “tailf-ncs:package”: [
- {
- “name”: “cw-device-auth”,
- “package-version”: “7.0.0”,
- “description”: “Crosswork device authorization actions pack”,
- “ncs-min-version”: [“6.1”],
- “python-package”: {
- “vm-name”: “cw-device-auth”
- },
- “directory”: “/var/opt/ncs/state/packages-in-use/1/cw-device-auth”,
- “component”: [
- {
- “name”: “action”,
- “application”: {
- “python-class-name”: “cw_device_auth.action.App”,
- “start-phase”: “phase2”
- }
- }
- ],
- “oper-status”: {
- “up”: [null]
- }
- }
- ]
- }
Ajout d'une carte utilisateur (umap) au groupe d'authentification Cisco NSO
Cisco NSO permet aux utilisateurs de définir des groupes d'authentification pour spécifier les identifiants d'accès aux périphériques en aval. Un groupe d'authentification peut contenir une table par défaut ou une table utilisateur (UMAP). De plus, une table UMAP peut être définie dans le groupe d'authentification pour remplacer les identifiants par défaut de la table par défaut ou d'autres tables UMAP.
La fonctionnalité Crosswork Change Automation « remplacer les informations d'identification » utilise cette umap. Pour utiliser Crosswork Change Automation, une configuration umap doit être créée dans le groupe d'authentification pour les appareils.
Par exempleample, considérez que vous disposez d’un périphérique « xrv9k-1 » inscrit dans Cisco NSO. Cet appareil utilise le groupe d'authentification « crosswork ».
- cwuser@ncs# afficher les périphériques de configuration en cours d'exécution périphérique xrv9k-1 authgroup périphériques périphérique xrv9k-1
- authgroup crosswork
- !
Et la configuration du groupe d’authentification « crosswork » est la suivante :
- cwuser@ncs# show running-config devices authgroups group crosswork devices authgroups group crosswork
- administrateur umap
- remote-name cisco
- mot de passe distant $9$LzskzrvZd7LeWwVNGZTdUBDdKN7IgVV/UkJebwM1eKg=
- !
- !
- Ajoutez un umap pour le nouvel utilisateur que vous avez créé (cwuser dans cet example). Cela peut être fait comme suit:
- cwuser@ncs#config
- cwuser@ncs(config)# devices authgroups group crosswork umap cwuser callback-node /cw-creds-get action-name get
- cwuser@ncs(config-umap-cwuser)# commit exécution à sec
- cli {
- nœud local {
- périphériques de données {
- groupes d'authentification {
- groupe de travail croisé {
- + umap cwuser {
- + callback-node /cw-creds-get;
- + action-name get;
- + }
- }
- }
- }
- }
- }
- cwuser@ncs(config-umap-cwuser)# commit
- Engagement terminé.
Après la configuration, le groupe d'authentification devrait ressembler à ceci :
- cwuser@ncs# afficher les périphériques de configuration en cours d'exécution authgroups groupe crosswork
- groupes d'authentification de périphériques, groupement croisé
- administrateur umap
- remote-name cisco
- mot de passe distant $9$LzskzrvZd7LeWwVNGZTdUBDdKN7IgVV/UkJebwM1eKg=
- !
- utilisateur umap cw
- nœud de rappel /cw-creds-get
- nom-action obtenir
- !
- !
Assurez-vous que
- umap is added to an existing authgroup of the device(s) of interest.
- umap utilise le bon nom d'utilisateur.
Si l’une des configurations ci-dessus est incorrecte, des problèmes d’exécution peuvent survenir.
Configuration de DLM dans Cisco Crosswork
Après avoir installé et configuré le pack de fonctions dans Cisco NSO, vous devez configurer DLM dans Cisco Crosswork. Ces paramètres de configuration permettront à Change Automation d'accéder à Cisco NSO via le nouvel utilisateur et de configurer à l'aide des identifiants de remplacement si nécessaire.
Créer ca_device_auth_nso Credential Profile
Créer un nouveau titre de profile dans Cisco NSO pour l'utilisateur à accès spécial que vous avez créé dans la section Création d'un utilisateur à accès spécial dans NSO de ce guide. Ajoutez les informations d'identification HTTP et HTTPS de l'utilisateur dans cette information d'identification professionnellefile. L'image ci-dessous montre la spécification de l'utilisateur et du mot de passe pour l'utilisateur, « cwuser ».
IMPORTANT
Avec le pro des informations d'identification ca_device_auth_nsofile, vous aurez un autre titre profile dans DLM qui spécifierait les informations de nom d'utilisateur/mot de passe à Cisco NSO pour tous les autres composants de Cisco Crosswork. Dans l'exampci-dessous, ce titre de profile s'appelle « nso-creds ».
Important : assurez-vous que le nom d'utilisateur pour les informations d'identification DLM standard profile est différent du nom d'utilisateur dans ca_device_auth_nso profile.
Ajouter une propriété de fournisseur DLM
Une fois que vous avez créé le credential profile Dans DLM, vous devez ajouter une propriété à tous les fournisseurs Cisco NSO de DLM, qui sera utilisée dans Crosswork CA. L'image ci-dessous illustre la spécification de la propriété.
Dépannage
Le tableau suivant répertorie les erreurs courantes que vous pourriez éventuellement rencontrer.
| Non. | Sous-chaîne d'erreur | Problème | Résolution |
| 1. | L'utilisateur nso umap doit également être un professionnel des informations d'identification nso.file utilisateur | Le nom d'utilisateur ca_device_auth_nso ne correspond à aucun utilisateur umap. |
|
| 2. | groupe d'authentification vide umap de nso | Aucun umap trouvé dans le groupe d'authentification Cisco NSO. | Ajoutez l'umap. |
| 3. | failed to retrieve RESTCONF resource root. please verify NSO <IP> is reachable via RESTCONF | Crosswork CA n'a pas réussi à se connecter à Cisco NSO via RESTCONF. | Ensure that the username/password as specified in cw_device_auth_nso cred profile peut se connecter à Cisco NSO via RESTCONF. |
L'ensemble de documentation de ce produit s'efforce d'utiliser un langage sans parti pris. Aux fins de cet ensemble de documentation, l'absence de préjugés est définie comme un langage qui n'implique pas de discrimination fondée sur l'âge, le handicap, le sexe, l'identité raciale, l'identité ethnique, l'orientation sexuelle, le statut socio-économique et l'intersectionnalité. Des exceptions peuvent être présentes dans la documentation en raison du langage codé en dur dans les interfaces utilisateur du logiciel du produit, du langage utilisé sur la base de la documentation des normes ou du langage utilisé par un produit tiers référencé. Cisco et le logo Cisco sont des marques ou des marques déposées de Cisco et/ou de ses filiales aux États-Unis et dans d'autres pays. Pour view une liste des marques déposées de Cisco, allez ici URL: https://www.cisco.com/c/en/us/about/legal/trademarks.html. Les marques commerciales de tiers mentionnées sont la propriété de leurs propriétaires respectifs. L'utilisation du mot partenaire n'implique pas de relation de partenariat entre Cisco et une autre société. (1721R)
FAQ
What version of Cisco NSO is compatible with this function pack?
The function pack is compatible with Cisco NSO 6.1.11.2 or higher.
Documents / Ressources
 |
Pack de fonctions NSO d'automatisation des changements CISCO [pdf] Guide d'installation Pack de fonctions d'automatisation des modifications NSO, Pack de fonctions d'automatisation NSO, Pack de fonctions NSO, Pack de fonctions |