Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility

1 Configuration Development Kit Overview

• About the Configuration Development Kit
• Restrictions
• Pre-Defined Scripts

2 Driver Scripts

• About Driver Scripts
• About Script Types and Targets
  • Applying Roles
  • Policy Targets
• About Context-Specific Parameters
  • Local Context
  • Inherited Context
• About Scheduling of Scripts
• About Running Scripts
  • Scripts to Install Configuration
  • Scripts to Remove Configuration
• About Sharing Data Between Scripts

3 Using Existing Scripts

• Importing Scripts
• Viewing and Organizing Scripts
  • Creating Driver Script Folders
  • Viewing a Summary of Scripts
  • Viewing the Entire Text of Scripts
  • Viewing Script Properties
• Associating Roles with Scripts
• Setting Variables
  • Setting Variables in the Preamble Section
  • Setting Variables in the Local Context for an Object
• Associating Scripts with Objects
  • Linking Scripts to Objects
  • Re-running a Script
• Removing Scripts
• Propagating Configuration
  • Applying Configuration
  • Removing Configuration
• Deleting Scripts

4 Developing Scripts

• About Developing Scripts
• Creating a Script
  • Using the Template File
  • Creating a Script Using a Text Editor
  • Creating a Script from the IP Service Activator Client
• Structure of a Script
  • The Preamble Section
  • The Behavior Section
  • The Common Section
  • The Install Section
  • The Remove Section
• Exporting Scripts
• Programming Tips
  • Script Conventions
  • Command Format
  • Handling Exceptions
  • Displaying Errors in IP Service Activator
  • Applying Commands
  • Preventing Command Application
  • Processing Command Output
  • Returning a Result
  • Re-applying Configuration
  • Managing Script Context

5 Sharing Data Between Scripts

• About Sharing Data Between Scripts
• Using Classes
• Using a Python Dictionary
• Storing and Retrieving Data
• An Example of Using the Shared Data Area
  • Types of Script
  • About the Example
  • Data Script: setIPAddress.py
    • Listing of setIPAddress.py
    • Explanation of setIPAddress.py
  • Data Script: setDescription.py
    • Listing of setDescription.py
  • Behavior Script: processInterfaces.py
    • Listing of processInterfaces.py
    • Explanation of processInterfaces.py
  • Controller Script: BehaviorAndCommandController.py
    • Listing of BehaviorAndCommandController.py
    • Explanation of BehaviorAndCommandController.py
• Error Reporting in Behavior Scripts

6 Monitoring and Troubleshooting Scripts

• Checking the Status of Scripts
• Understanding Warnings and Error Messages
• Checking Logs

7 Definition of Standard Methods

• Summary of Methods
• General Context
  • The _result Object
    • The setCode Method
    • The setDetails Method
    • The sendScriptObjectFailure Method
• Device Context
  • The _device Object
    • The openSession Method
    • The deliverCommand Method
    • The closeSession Method
    • The getIpAddress Method
    • The getIos Method
    • The getOs Method
    • The getDeviceType Method
    • The getFeatureSet Method
    • The getNumberOfInterfaces Method
    • The getThisCommitSharedData Method
    • The getLifetimeSharedData Method
    • The getInterface Method
    • The log Method
    • The auditLog Method
• Interface Context
  • The _interface Object
    • The getInterfaceName Method
    • The getIpAddress Method
    • The getVipType Method
    • The getAdapterType Method
    • The getNumberOfFramePvcs Method
    • The getNumberOfAtmPvcs Method
    • The getFramePvc Method
    • The getAtmPvc Method
• ATM PVC Context
  • The _atm_pvc Object
    • The getVpi Method
    • The getVci Method
• Frame PVC Context
  • The _frame_pvc Object
    • The getDlci Method

A Pre-defined Scripts

• Save to NVRAM
• Add VLAN to CatOS
• Force a FastStart Mode Exit for Cisco Devices

B Sample Scripts for Using the Shared Data Area

• Sample Python Module
• Sample Behavior Script
• Sample Data Script
• Sample Controller Script