Release Announcement: NSO 6.5 is now released.
Head to the release highlights to see what's new
LogoLogo
NSO DevCenterTry NSO
NSO 6.5
  • Get Started
  • User Guides
  • Developers
  • Release Info
NSO 6.5
  • 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
      • CDB Persistence
      • IPC Connection
      • Cryptographic Keys
      • 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
      • Device Manager
      • Out-of-band Interoperation
      • 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
      • Encrypted Strings
  • 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
  • Create a Service
  • Edit Service Configuration
  • Apply an Action on a Service
  • View Service Details
  • 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 3 days ago

Was this helpful?

The Services view is used to view, create, and manage services in your NSO deployment. The default Services view displays the existing services.

Search

If you have several services configured, you can use the Search to filter down results to the service 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. In the Select service type drop-down, select the service point 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

To create and deploy a service:

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

  2. Click the Add service button. You will be redirected to the Configuration editor view.

  3. In the Add new list item pop-up, enter the required information, which in this case is the name of the service.

  4. Confirm the intent.

  5. Configure additional service data in the Configuration editor view.

  6. Review and commit the service to NSO in the Commit manager. Committing the service deploys it to NSO and displays it in the Services view.

Edit Service Configuration

Service configuration is viewed and carried out in the Configuration Editor. In the Services view, you can use the Modify in Config Editor option on the desired service to access its config in the Configuration Editor.

To rename a service:

  1. Navigate to the service using the Configuration Editor and access the Edit config tab.

  2. Select the service in the list using the checkbox.

  3. Click the pencil icon.

  4. Rename the service in the pop-up.

  5. Commit the change in the Commit manager.

To edit service configuration:

  1. Navigate to the service using the Configuration Editor and access the Edit config tab.

  2. Click the service name in the list.

  3. Make the changes.

  4. Commit the changes in the Commit manager.

The other two tabs, i.e., Config and Operdata can be used respectively to view the service configuration and operational data.

Apply an Action on a Service

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

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

To apply an action on a service:

  1. Choose the preferred action from the list, i.e., Re-deploy, Un-deploy, Check sync, Deep check sync, or get modifications.

The Check sync action can be run on multiple services at once by selecting them using the checkbox and then running the action using the Choose actions button.

Actions Possible in the Services View

The Modify in Config Editor and Delete are GUI-specific operations accessible on the service row.

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

  1. Access the service in the Configuration Editor. This you can do by selecting the Modify in Config Editor option in the Services view.

  2. Access the Actions tab in the Configuration editor view.

  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

View Service Details

To view details of a service:

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

  2. Click the desired service. This opens up the service details view.

  3. Browse service details using the following tabs:

    • Details

    • Plan

    • Log

Delete a Service

To delete a service instance:

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

  2. Select, using the checkbox, the service to be deleted. You can select multiple services at once.

  3. Click Delete.

  4. Confirm the intent in the pop-up.

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

To skip the Commit Manager review, use the Commit changes directly option in the Delete service instance pop-up.

Click the plus button.

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.

On the desired service in the list, click the more options button.

Available actions include Re-deploy, Un-deploy, Check sync, Deep check sync, and get modifications. See for the details of these actions.

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

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

Services
Developing Services
Lifecycle Operations
Lifecycle Operations
Services View