Tools
Tools to view NSO status and perform specialized tasks.
Last updated
Tools to view NSO status and perform specialized tasks.
Last updated
© Copyright 2024 Cisco Systems, Inc. | This site is part of the official Cisco Crosswork NSO documentation set.
The Tools view includes utilities that you can use to run specific tasks on your deployment, such as running compliance reports, etc.
The following tools are available:
Insights: Gathers and displays useful statistics of your deployment.
Package upgrade: Used to perform upgrades to the packages running in NSO.
High availability: Used to manage a High Availability (HA) setup in your deployment.
Alarms: Shows current alarms/events in your deployment and provides options to manage them.
Commit manager: Shortcut to the Commit Manager.
Compliance reports: Used to run compliance checks on your NSO network.
The Insights view collects and displays the following types of operational information using the /ncs:metrics data model to present useful statistics:
Real-time data about transactions, commit queues, and northbound sessions.
Sessions created and closed towards northbound interfaces since the last restart (CLI, JSON-RPC, NETCONF, RESTCONF, SNMP).
Transactions since last restart (committed, aborted, and conflicting). You can select between the running and operational data stores.
Devices and their sync statuses.
CDB info about its size, compaction, etc.
In the Package upgrade view, you can load custom packages in NSO.
The Reload button on the Packages pane is the equivalent of the packages reload command in CLI. Read more about the reload action in NSO Packages.
To install a new package:
In the Package upgrade view, click Browse files to select a new package (.tar or .tar.gz) from your local disk.
Click Upload. The package becomes visible under the Available pane. (The Progress Trace shows the real-time progress of the upload).
Click Install.
On the Loaded pane, click Reload and confirm the intent.
To uninstall an existing package:
To uninstall a package, simply click Deinstall next to the package in the Loaded packages list.
The High Availability view is used to visualize your HA setup (rule-based or Raft).
Actions can be performed on the cluster using the Configuration editor -> Actions tab. Possible actions are further described in the High Availability documentation under Actions.
The Alarm manager view displays current alarms in the system. The alarms are categorized as criticals, majors, and minors and can be filtered by the device.
The Commit manager displays notifications about commits pending to be approved. Any time a change (a transaction) is made in NSO, the Commit Manager displays a notification to review the change. You can then choose to confirm or revert the commit.
Transactions and Commits
Take special note of the Commit Manager. Whenever a transaction has started, the active configuration data changes can be inspected and evaluated before they are committed and pushed to the network. The data is saved to the NSO datastore and pushed to the network when a user presses Commit.
Any network-wide configuration change can be picked up as a rollback file. The rollback can then be applied to undo whatever happened to the network.
To review a configuration change:
Review the available changes appearing as Current transaction. If there are errors in the change, the Commit Manager alerts you and suggests possible corrections. You can then fix them and press Re-validate to clear the errors.
Click Revert to undo or Commit to confirm the changes in the transaction.
Commit Options: When committing a transaction, you have the possibility to choose Commit options and perform a commit with the specified commit option(s). Examples of commit options are: No revision drop, No deploy, No networking, etc. Commit options are described in detail in the JSON-RPC API documentation under Methods - transaction - commit changes.
Start a transaction to load or save configuration data using the Load/Save option which you can then review for commit. The following tabs are available:
Rollback, to load data that reverts an earlier change.
Files, to load data from a local file on your disk.
Paste, to load data by pasting it in.
Save, to save loaded data to a file on your local disk.
In the Commit manager view, the following tabs are shown.
changes tab, to list the changes and actions done in the system, e.g., deleting a device or changing its properties.
errors tab, to list the errors encountered while doing changes. You can review the errors, make changes, and revalidate the error using the Re-validate option.
warnings tab, to list the warnings encountered while doing changes.
config tab, to list the configuration changes associated with the change.
native config tab, to list the device configuration data in the native config.
commit queue tab, to manage commit queues. See Commit Queue for more information.
The Compliance reporting view is used to create and run compliance reports to check the current situation, check historical events, or both. The conceptual aspects of the compliance reporting feature are discussed in greater depth in the Compliance Reports section.
Web UI is the recommended way of running the compliance reports.
The following tabs are available in this view:
Compliance reports
Report results
The Compliance reports tab is used to view, create, run, and manage the existing compliance reports.
To create a new compliance report:
In the Compliance reporting view -> Compliance reports tab, click New report.
In the Create new report pop-up, enter the report name and click Create.
Next, set up the compliance report using the following tabs. For a more detailed description of Compliance Reporting concepts and related configuration options, see Compliance Reporting.
General tab: to configure the report name. Configuration options include:
Report name: Displays the report name and allows editing of the report name.
Devices tab: to configure device compliance checks. Configuration options include:
Device choice: Include All devices or only Some devices to include in compliance checks. If Some devices is selected, specify the devices using a device group, an XPath expression, or individual devices.
Current out of sync: Check the device's current status and report if the device is in sync or out of sync. Possible values are true (yes, request a check-sync) and false (no, do not request a check-sync).
Historic changes: Include or exclude previous changes to devices using the commit log. Possible values are true (yes, include), and false (no, exclude).
Compliance templates: If a compliance template should be used to check for compliance (see Device Configuration Checks). You have the option to add a compliance template using the Add template option or convert an existing device template into a compliance template by using the Create from device template option (which can then be added using the Add template option). To enforce devices to comply exactly with the template's configuration, use Strict mode; see Additional Configuration Checks for more information.
Services tab: to configure service compliance checks. Configuration options include:
Service choice: Include All services or only Some services. If Some services is selected, specify the services using service type, an XPath expression, or individual service instances.
Current out of sync: Check the service's current status and report if the service is in sync or out of sync. Possible values are true (yes, request a check-sync) and false (no, do not request a check-sync).
Historic changes: Include or exclude previous changes to services using the commit log. Possible values are true (yes, include), and false (no, exclude).
Click Create report when the report setup is complete. The changes are saved and applied immediately.
Copy as new report: Copy an existing report as a new report.
Run: Run the report.
Delete: Delete the report.
Edit name: Edit the report name.
To run a compliance report:
In the Compliance reports tab, click the desired report and then click Run report.
Specify the following in the Run report pop-up:
Report title
Historical time interval. Select the time range. The report runs with the maximum possible interval if you do not specify an interval.
Click Run report.
The Reports results tab is used to view the status and results of the compliance reports that have been run.
The report's results show if the devices/services included in the report are compliant or have violations. A summary of the report status is available readily in the Report results tab. To fetch detailed information on the report, click the report name. The following information panes are then available:
Details: Includes specifics about the report that was run, such as report name, date/time it was run, time range, and contents analyzed (i.e., services, devices, and rollback files).
Results overview: Shows a summary of the results with information on the number of compliant and non-compliant devices/services.
Devices/Services/Errors: Displays individual compliance and error information for analyzed devices and services. In case of non-compliance, a 'diff view' is available.
Use the Export to file button to export the report results to a downloadable file (PDF).
You can run actions on an alarm by selecting it and using the run action button.
Access the Commit Manager by clicking its icon in the banner.
In the Commit manager view, you can fetch additional information about the leaf by enabling more node options and clicking the info button.
In the Compliance reports tab, you can apply the following actions on the report by selecting it using the checkbox and using the more options button.
