Release Announcement: NSO 6.5 is now released.
Head to the release highlights to see what's new
LogoLogo
NSO DevCenterTry NSO
NSO 6.3
  • Get Started
  • User Guides
  • Developers
  • Release Info
NSO 6.3
  • Start
  • What's New
  • Administration
    • Get Started
    • Installation and Deployment
      • Local Install
      • System Install
      • Post-Install Actions
        • Explore the Installation
        • Start and Stop NSO
        • Create NSO Instance
        • Enable Development Mode
        • Running NSO Examples
        • Migrate to System Install
        • Modify Examples for System Install
        • Uninstall Local Install
        • Uninstall System Install
      • Containerized NSO
      • Deployment Example
      • Upgrade NSO
    • Management
      • System Management
        • Cisco Smart Licensing
        • Log Messages and Formats
        • Alarm Types
      • Package Management
      • High Availability
      • AAA Infrastructure
      • NED Administration
    • Advanced Topics
      • Locks
      • Compaction
      • IPC Ports
      • Service Manager Restart
      • Security Issues
      • Run NSO as Non-Privileged User
      • IPv6 on Northbound Interfaces
      • Layered Service Architecture
  • Operation & Usage
    • Get Started
    • CLI
      • Introduction to NSO CLI
      • CLI Commands
    • Web UI
      • Home
      • Devices
      • Services
      • Config Editor
      • Tools
    • Operations
      • Basic Operations
      • NEDs and Adding Devices
      • Manage Network Services
      • NSO Device Manager
      • SSH Key Management
      • Alarm Manager
      • Plug-and-Play Scripting
      • Compliance Reporting
      • Listing Packages
      • Lifecycle Operations
      • Network Simulator
  • Development
    • Get Started
    • Introduction to Automation
      • CDB and YANG
      • Basic Automation with Python
      • Develop a Simple Service
      • Applications in NSO
      • Develop and Deploy a Nano Service
    • Core Concepts
      • Services
      • Implementing Services
      • Templates
      • Nano Services
      • Packages
      • Using CDB
      • YANG
      • NSO Concurrency Model
      • Service Handling of Ambiguous Device Models
      • NSO Virtual Machines
        • NSO Python VM
        • NSO Java VM
        • Embedded Erlang Applications
      • API Overview
        • Python API Overview
        • Java API Overview
      • Northbound APIs
        • NSO NETCONF Server
        • RESTCONF API
        • NSO SNMP Agent
    • Advanced Development
      • Development Environment and Resources
      • Developing Services
        • Services Deep Dive
        • Service Development Using Java
        • NSO Developer Studio
      • Developing Packages
      • Developing NEDs
        • NETCONF NED Development
        • CLI NED Development
        • Generic NED Development
        • SNMP NED
        • NED Upgrades and Migration
      • Developing Alarm Applications
      • Kicker
      • Scaling and Performance Optimization
      • Progress Trace
      • Web UI Development
        • JSON-RPC API
    • Connected Topics
      • SNMP Notification Receiver
      • Web Server
      • Scheduler
      • External Logging
      • Encryption Keys
  • Resources
    • Manual Pages
      • Section 1
      • Section 3
      • Section 5
Powered by GitBook
LogoLogo

Site

  • Cisco.com
  • Documentation
  • Learning Labs
  • Sample Code

Connect

  • Feedback
  • Community
  • Blogs
  • Events

Follow Us

  • X/Twitter
  • Facebook
  • YouTube
  • LinkedIn

© Copyright 2025 Cisco Systems, Inc. | This site is part of the official Cisco Crosswork NSO documentation set.

On this page
  • Search Filter
  • Create a Service
  • Apply an Action on a Service
  • Edit Service Configuration
  • Delete a Service

Was this helpful?

Edit on GitHub
Export as PDF
  1. Operation & Usage
  2. Web UI

Services

Create and manage service deployment.

PreviousDevicesNextConfig Editor

Last updated 11 months ago

Was this helpful?

The Service manager view is where you create, deploy, and manage services in your NSO deployment. Available services are displayed in this view by default.

Columns in the Services List

  • name: The name of the service.

  • plan: Shows the service plan.

  • devices: Shows the number of devices associated with the service. Use the refresh button to reload the devices list.

  • check-sync, re-deploy, and re-deploy dry-run denote the actions that you can perform on a service.

Search Filter

If you have several services configured, you can use the Search filter to filter down results to the services(s) of your choice. The search filter matches the entered characters to the service name and shows the results accordingly. Results are shown only for the service point that you have selected.

To filter the service list:

  1. Select the desired service point from the list to populate all the services under it.

  2. Enter a partial or full name of the service you are searching for.

  3. Press Enter.

Create a Service

  1. In the Select service point drop-down list, select a service point.

  2. In the Create service pop-up, enter the name of the service.

  3. Confirm the intent.

  4. Review and commit the service to NSO in the Commit manager.

Apply an Action on a Service

You can apply actions on a service from the Service manager view or the Configuration editor.

Start by selecting a service point to populate all services under it, and then follow the instructions below.

You can apply an action on a single service or multiple services at once.

To apply an action on a service:

  • On the desired service in the list, click the action button (i.e., check-sync, re-deploy, or re-deploy dry-run).

To apply an action on multiple services:

  1. Select the desired services from the list.

  2. Confirm the intent.

Actions Possible in the Service Manager View

Available actions include check-sync, re-deploy, and re-deploy dry-run.

Action Result

The result of running a basic action is displayed using one of the following colors:

  • A red button color means that the action was unsuccessful.

  • A green button color means that the action was successful.

Expand the button further to get more information about the result.

Additional actions are applied per individual service. Use this option if you want to run an action with additional parameters.

  1. Click the service name in the list.

  2. Access the Actions tab in the Configuration editor.

  3. Click the desired action in the list.

  4. At this point, you can configure different parameters.

    (Use the Reset action parameters option to reset all parameters to default value).

  5. Run the action.

Actions Possible in the Configuration Editor -> Actions Tab

Access the service in the Configuration editor to run the following actions: reactive-re-deploy, un-deploy, deep-check-sync, touch, set-rank, get-modifications, purge.

Edit Service Configuration

Service configuration is viewed and carried out in the Configuration Editor.

To start configuring a service:

  1. Click the service name in the list.

  2. In the Configuration editor, access the Edit config tab to make changes to the service.

  3. Commit the changes in the Commit manager.

The other two tabs, i.e., Config and Operdata can be respectively used to:

  • View the service configuration, and,

  • View the service's operational data.

Delete a Service

  1. In the services list, click the service that you want to delete. You can select multiple services.

  2. Review and commit the change in the Commit manager.

Hide and display the columns of your choice by using the column selection icon.

Click the add button.

Using the run action button, select the desired service action.

See for the details of these actions.

Fetch the action information by clicking the info icon in the Configuration editor -> Actions tab.

See for the details of these actions.

The Configuration editor view shows a host of options when configuring a service. You are expected to be well-versed with these options (and service concepts in general) before you delve into service configuration. Refer to the and documentation for more information.

Click the remove button.

Lifecycle Operations
Lifecycle Operations
Services
Developing Services
Service Manager View