System Setup and Software Installation Guide for Cisco Optical Site Manager, IOS XR

PDF

Custom scripts

Want to summarize with AI?

Log in

Overview

This topic explains custom Scripts in the Cisco Optical Site Manager admin plane. It describes key behavior, required inputs, and operational considerations so you can understand the feature before configuration, monitoring, or troubleshooting.

This topic explains custom Scripts in the Cisco Optical Site Manager admin plane. It describes key behavior, required inputs, and operational considerations so you can understand the feature before configuration, monitoring, or troubleshooting.

Custom scripts details

Custom scripts are quick solutions that are specific to each feature. The scripts provide access to the full application object model to extend the capabilities of the admin plane at runtime

The custom scripts let you do the following actions and more:

  • Add UI- and REST-based custom actions

  • Define in a declarative way web input forms for action parameters

  • Export data in different text formats

  • Add custom validation logic, for example, when creating a new Cisco Optical Site Manager instance

  • Perform custom tasks on application events, for example, when the HA role changes

  • Define scripted HA services that can communicate through the Admin Plane GRPC channels

The scripts table displays the added scripts and the relevant script details. The following list describes the table items.

  • Name—Name of the custom script

  • Type—Type of the custom script

  • Target—Target GUI of the Cisco Optical Site Manager admin plane

  • Status—Status of the custom script

  • Version—Version of the custom script added

  • Lifetime—Duration of the script in the admin plane in dd:hh:mm:ss format

  • Action—Action to delete the added script


Add custom scripts

Use this task to add custom scripts to the Admin Plane.

Before you begin

Log in to the admin plane

Procedure

1.

Click Scripts in the left panel.

The Scripts page appears.

2.

Click Add new Cisco Optical Site Manager script.

An explorer window opens.

3.

Select a custom script and click Open, for example, importInstancesCSV file.

A Success message appears.

4.

Click OK.

The importInstancesCSV script is added to the scripts table.

5.

Check the Cisco Optical Site Manager Instances table in the admin plane for the Import CSV button.

The Import CSV button allows you to import the Cisco Optical Site Manager instances using a CSV file.

The custom script is added to the scripts table and is available in the admin plane.