EMC Ionix Network Configuration Manager Device Services Support (DSr)

Transcription

1 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide P/N REV A01

2 Copyright EMC Corporation. All rights reserved. Published in the USA. Published January 6, 2012 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. EMC2, EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries. All other trademarks used herein are the property of their respective owners. For the most up-to-date regulatory document for your product line, go to the technical documentation and advisories section on the EMC online support website. 2 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

3 CONTENTS Preface Chapter 1 Chapter 2 Chapter 3 Chapter 4 Chapter 5 Chapter 6 Chapter 7 Chapter 8 Appendix A Introduction About this Manual Compatibility Device Management and Customization Types of Customization Implementing and Preserving Customizations Overview Using the VOYENCE_HOME/custompackage directory Additional Information Customizing Device Prompts Introduction Device Drivers XML Prompt Support Change Prompt Example Customizing Event SYSLOG and TRAP Filtering Introduction Usage Explanation of XML Elements and Detailed Usage Additional Information Changing the Syslog Message Parsing Editing syslog.xml Use Cases: Using the custompackage Folder/Directory Case 1: Make Changes to the Driver File in.dasl or.inc (Implementation Only) Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) Case 3: SEARCHORDER= Case 4: Application interface Changes Quick Driver Tool Quick Driver tool Accessing the Quick Driver tool Device Server Configuration Important Notes CiscoPIXFirewallSysLog.xml EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide 3

4 Contents CiscoPIXFirewallTrap.xml Additional examples for XMLs Glossary Index 4 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

5 PREFACE As part of an effort to improve its product lines, EMC periodically releases revisions of its software and hardware. Therefore, some functions described in this document might not be supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information on product features. Contact your EMC representative if a product does not function properly or does not function as described in this document. Note: This document was accurate at publication time. New versions of this document might be released on the EMC online support website. Check the EMC online support website to ensure that you are using the latest version of this document. Purpose Audience This document describes how to configure and use EMC Ionix Network Configuration Manager Device Services Support (DSr). This document is part of the EMC Ionix Network Configuration Manager documentation set, and is intended for use by those individuals who have the responsibility of installing and deploying EMC Ionix Network Configuration Manager Readers of this document are expected to be familiar with the following topics: Windows, Solaris, and Linux operating system Database architecture and concepts Security management Internet protocols, including HTTP, TCP/IP, File Transfer Protocol (FTP), and Telnet Lightweight Directory Access Protocol (LDAP) and directory services Authentication and authorization. Related documentation The following EMC publications provide additional information: EMC Ionix Network Configuration Manager Device Services Support (DSr) Release Notes EMC Ionix Network Configuration Manager Device Services Support (DSr) Support Matrix EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide 5

6 Preface Conventions used in this document EMC uses the following conventions for special notices: DANGER indicates a hazardous situation which, if not avoided, will result in death or serious injury. WARNING indicates a hazardous situation which, if not avoided, could result in death or serious injury. CAUTION, used with the safety alert symbol, indicates a hazardous situation which, if not avoided, could result in minor or moderate injury. NOTICE is used to address practices not related to personal injury. Note: A note presents information that is important, but not hazard-related. IMPORTANT An important notice contains information essential to software or hardware operation. Typographical conventions EMC uses the following type style conventions in this document: Normal Bold Italic Used in running (nonprocedural) text for: Names of interface elements, such as names of windows, dialog boxes, buttons, fields, and menus Names of resources, attributes, pools, Boolean expressions, buttons, DQL statements, keywords, clauses, environment variables, functions, and utilities URLs, pathnames, filenames, directory names, computer names, links, groups, service keys, file systems, and notifications Used in running (nonprocedural) text for names of commands, daemons, options, programs, processes, services, applications, utilities, kernels, notifications, system calls, and man pages Used in procedures for: Names of interface elements, such as names of windows, dialog boxes, buttons, fields, and menus What the user specifically selects, clicks, presses, or types Used in all text (including procedures) for: Full titles of publications referenced in text Emphasis, for example, a new term Variables 6 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

7 Preface Courier Used for: System output, such as an error message or script URLs, complete paths, filenames, prompts, and syntax when shown outside of running text Courier bold Used for specific user input, such as commands Courier italic Used in procedures for: Variables on the command line User input variables < > Angle brackets enclose parameter or variable values supplied by the user [ ] Square brackets enclose optional values Vertical bar indicates alternate selections the bar means or { } Braces enclose content that the user must specify, such as x or y or z... Ellipses indicate nonessential information omitted from the example Where to get help EMC support, product, and licensing information can be obtained as follows: Product information For documentation, release notes, software updates, or information about EMC products, licensing, and service, go to the EMC online support website (registration required) at: Technical support For technical support, go to EMC online support and select Support. On the Support page, you will see several options, including one to create a service request. Note that to open a service request, you must have a valid support agreement. Contact your EMC sales representative for details about obtaining a valid support agreement or with questions about your account. Your comments Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Send your opinions of this document to: techpubcomments@emc.com EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide 7

8 Preface 8 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

9 CHAPTER 1 Introduction This chapter presents these topics: About this Manual Compatibility Introduction 9

10 Introduction About this Manual The following information is included in this Device Server Configuration Guide document: Device Management Information Customization Information for the following: Device Prompts Event Filtering Use Cases for the Custom Package Directory Device Server Configuration Information Compatibility This release is certified to work with EMC Ionix Network Configuration Manager Release 4.1.1, on the following environments: Red Hat Enterprise Linux 4 Red Hat Enterprise Linux 5 Microsoft Windows Server 2003 Microsoft Windows Server 2008 R2 Solaris EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

11 CHAPTER 2 Device Management and Customization This chapter presents this topic: Types of Customization Device Management and Customization 11

12 Device Management and Customization Types of Customization On occasion, customers may require customizations to their device server implementation to properly interact with their network environment. There are three types of customizations supported in the product today. The most common customizations include: Changing the prompts that a device driver should use when logging into a device. Updating the traps and syslog events that the device driver should recognize from a specific device type. Advanced users and professional services organizations can also modify existing drivers or create new device support using the DASL script language. The EMC Network Configuration Manager Device Access Scripting Language (DASL) Specifications Guide contains additional information on the DASL language specification. 12 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

13 CHAPTER 3 Implementing and Preserving Customizations This chapter presents these topics: Overview Using the VOYENCE_HOME/custompackage directory Additional Information Implementing and Preserving Customizations 13

14 Implementing and Preserving Customizations Overview This section includes the steps required to implement and preserve existing customizations, as well as describing the process for changing prompts and the events recognized. Note: This information is also available in the install under VOYENCE_HOME/package/customizationREADME.txt. The device server architecture allows local customizations to device drivers and control/data files in a directory separate from the distribution directory. This enables customers to create modified versions of these files without altering the files distributed with the product. By creating copies of the distributed files and making modifications to the copies, customers are insulated from the possibility of having their customizations overwritten during the application of maintenance, or in future product releases. This feature is provided using a custompackage directory, which can be searched prior to the device driver package directory distributed with the software. Device drivers or control files found in the custompackage directory are used; if they are absent, the system defaults to using the files from the device driver package directory distributed with the software. Note: Officially released hotfixes, and other driver components will always be installed in the package directory, and not in the custompackage directory. Using the VOYENCE_HOME/custompackage directory IMPORTANT Ensure you do not make any changes to the package Directory (VOYENCE_HOME/package), or to any of the package directory contents, other than the permissible changes described in this document. The following steps are used to access and use the custompackage Directory. 1. To create a modified version of a file distributed in the package directory, create a copy of the file in the custompackage directory (VOYENCE_HOME/custompackage), setting up the same directory structure as under the package directory. 2. Make the necessary modifications to that file. Use the following steps for this procedure: a. Identify the directory structure under the package directory containing the file that is to be modified. For example: VOYENCE_HOME/package/cisco/catos b. Create the exact same directory structure under the custompackage directory. For example: mkdir p VOYENCE_HOME/custompackage/cisco/catos c. Copy the file to be modified from the directory structure under the package directory, to the directory structure under the custompackage directory. For example: cp VOYENCE_HOME/package/cisco/catos/devCiscoCat.dasl 14 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

15 Implementing and Preserving Customizations d. VOYENCE_HOME/custompackage/cisco/catos/devCiscoCat.dasl 3. You can now make the needed changes to the file under the custompackage directory. For example: vi VOYENCE_HOME/custompackage/cisco/catos/devCiscoCat.dasl 4. Restart the device server services. If there are multiple device servers, make the same changes individually, on all device servers; meaning the same steps must be repeated on each device server. 5. If you are changing any of the following files, a restart the ControlDaemon. The following must be changed on the Application Server. DevicePackageSupport.xml Any of the.pkg files in the custompackage/pkgxml directory For Example: service controldaemon restart (UNIX) For Example: restart from the services panel on Windows (GUI) With this release, the addev.order changes are supported only in the package directory, as such, this file is not supported from the custompackage, and must be modified (if needed) in its original package directory location. 6. SEARCHORDER : By default, the software will look for the driver control/data files in the custompackage first, then look in the package directory second. It is possible (although not recommended), to alter the search order to ignore either the custompackage directory or the package directory altogether. This is accomplished by modifying the PACKAGEDIR_SEARCHORDER value in the infrastructures database. Permissible values for PACKAGEDIR_SEARCHORDER are listed in the following three steps. 7. Value = 1: search custompackage directory first, then package directory. This is the default, and if the PACKAGEDIR_SEARCHORDER value is not present, the system will use this value to control the directory search selection. 8. Value = 2: Ignore the custompackage directory, and use only the package directory to locate drivers and control/data files. 9. Value = 3: Ignore the package directory, and use only the custompackage directory to locate drivers and control/data files. 10. To alter the setting of the PACKAGEDIR_SEARCHORDER, use the following procedure on the application server. This SEARCHORDER change propagates to all device servers. 11. Stop all daemons and services on application servers, and device servers, and complete the steps below on the application server. Store the cflist to a text file that can be edited. For Example:. /etc/voyence.conf cd VOYENCE_HOME/cgi-bin. /cflist.cgi > out.txt Edit the contents of the resulting file, replacing the value for PACKAGEDIR_SEARCHORDER to create the desired system behavior. If PACKAGEDIR_SEARCHORDER is omitted (or removed), the system behaves as if it were set to 1 (the default value). Note that the value set for PACKAGEDIR_SEARCHORDER must be in quotes. For Example: Using the VOYENCE_HOME/custompackage directory 15

16 Implementing and Preserving Customizations Additional Information HEAD RTypeList= PollTypeList= UserList= DispositionList= DeliveryList= UrlList= PolList=1000 NetList=999: PACKAGEDIR_SEARCHORDER= 1 Rewrite the cflist using the new values from the edited file. For Example:./cfwrite.cgi <out.txt 12. Restart the Application and Device Server Services on all the servers. Stop all daemons and services before making any changes to the search order, and do not restart the daemons and services until after the changes have been made. For the Application Server Interface changes (for example, for controldaemon), only the CUSTOMPACKAGEFIRST (value 1) is supported in this release. All supported drivers and control/data files will be present in the package directory. Entries in custompackage directory are assumed to be modified, and are not supported. Note: It is the responsibility of the person completing the customization to ensure that the customized code is correct and adheres to the DASL compliance rules. 16 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

17 CHAPTER 4 Customizing Device Prompts This chapter presents these topics: Introduction Device Drivers XML Prompt Support Customizing Device Prompts 17

18 Customizing Device Prompts Introduction The device prompts that a driver can expect to encounter on accessing a device can be configured without modifications to the device driver. These modifications are made by copying the associated xml file into the custompackage directory, as described in the previous section. The device prompts are organized in a strict three-level hierarchy: 1. Global Prompts Default prompt regular expressions shared by all DASL Drivers. These are the standard prompts with the default prompt regular expressions values (such as, stdenablepromptstate). These prompt regular expressions are used if they are not explicitly overridden. 2. Device Class Prompts Overrides of the standard prompts with device class (such as, Cisco IOS Router) specific values. Also, new device class specific prompts can be defined in these files. These overrides are used for all devices of the device class (for example, all Cisco IOS Routers). 3. IDX Prompts Overrides of the standard prompts for a specific device (such as, Nortel Router with IDX 1432). Also, device class specific prompts can be overridden in these files. The prompt xml files are used by DASL each time the Network Configuration Manager Logs into a device. 1. First, the Global prompts xml file is read, and all of the standard prompts are initialized with the regular expressions in this file. 2. Next, the Device Class prompts xml file is read (if it exists), and all of the prompts listed in it are initialized. 3. Finally, if a Device Class prompts file exists and an IDX prompts xml file is present, all of the prompts listed are initialized. All prompt files are deployed into a subdirectory in the package/pkgxml directory of the Network Configuration Manager Installation directory. Prompt file changes should be placed in the corresponding custompackage directory. Note: Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) on page 28 provides more information on custompackage directory. 18 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

19 Customizing Device Prompts Device Drivers XML Prompt Support Change Prompt Example The following is an example for changing a prompt. As an example, consider a network where the prompt has been changed to LABNET on some of the Cisco Routers. Shown below is the default Device Class Prompts file for Cisco IOS Routers. <Prompts Version="1.0"> <CiscoIOSRouter> <EnablePromptState> <ID>1001</ID> <Expr><![CDATA[[-A-Za-z0-9_!@$%^&+ ~]+# *$]]></Expr> </EnablePromptState> <DisablePromptState> <ID>1002</ID> <Expr><![CDATA[> *$]]></Expr> </DisablePromptState> <ConfigPromptState> <ID>1003</ID> <Expr><![CDATA[[\(].*[\)] *# *$]]></Expr> </ConfigPromptState> <LoginPromptState> <ID>1004</ID> <Expr><![CDATA[ogin: sername?: [Ii][Dd]:]]></Expr> </LoginPromptState> <PasswordPromptState> <ID>1005</ID> <ciscoinvalidinputstate> <ID>10003</ID> <Expr><![CDATA[Invalid input ^% [Dd]uplicate Bad mask]]></expr> </ciscoinvalidinputstate> <ciscobannerpromptstate> <ID>10007</ID> <Expr><![CDATA[Enter TEXT message.]]></expr> </ciscobannerpromptstate> <ciscomenupromptstate> <ID>10010</ID> <Expr><![CDATA[User Interface Menu]]></Expr> </ciscomenupromptstate> </CiscoIOSRouter> </Prompts> To add LABNET as a valid prompt the <Expr> element of both the EnablePromptState and DisablePromptState elements in the file package/pkgxml/ciscoiosrouter/ciscoiosrouterprompts.xml, (relative to the Network Configuration Manager installation directory) must be modified to include LABNET The elements should be changed to the following: <Expr><![CDATA[[-A-Za-z0-9_!@$%^&+ ~]+# *$ LABNET]]></Expr> and <Expr><![CDATA[> *$ LABNET]]></Expr> Device Drivers XML Prompt Support 19

20 Customizing Device Prompts 20 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

21 CHAPTER 5 Customizing Event SYSLOG and TRAP Filtering This chapter presents these topics: Introduction Usage Explanation of XML Elements and Detailed Usage Additional Information Customizing Event SYSLOG and TRAP Filtering 21

22 Customizing Event SYSLOG and TRAP Filtering Introduction Usage Previously, the Network Configuration Manager introduced xml Configuration files for event filtering and recognition of config change events. These xml files can be edited and customized to fit the requirements of both the customer s environment and devices. These files are present in relevant class directory under the VOYENCE_HOME/package/pkgxml/ directory. For example, the CiscoIOSRouterTrap.xmp file is located in the /opt/voyence/package/pkgxml/ciscoiosrouter/ directory. 1. If a change to a file is needed, you can create a similar directory structure under the VOYENCE_HOME/custompackage/pkgxml/ directory and copy the file to the new directory. For example, copy the new file to the /opt/voyence/custompackage/pkgxml/ciscoiosrouter/ciscoiosroutertrap.xml directory and edit the copied file. See the Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) for more information. 2. Restart the Device Server Services. 3. The XML configuration file can be disabled by setting the <IsActive> value to false. In this case, fallback occurs to DASL scripts -> deviceevent function. Note: This is recommended in cases of complex event parsing not available via xml-like complex ANDing logic of regular expressions. 4. By default, all xml configurations except NetScreen Syslogs are enabled at installation. 5. New driver event files can be placed into the VOYENCE_HOME/custompackage/event/ directory as needed. See the Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) for more information. Explanation of XML Elements and Detailed Usage There are two xml Event files per driver; one file each for syslogs and SNMP traps. See the examples shown in Device Server Configuration on page 33. The format and description of the data is as follows. The trapconfig xml has a <TrapConfig> root element, while the syslog Config xml has a <SysConfig> root element. Each xml has exactly one <Package> sub element. 22 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

23 Customizing Event SYSLOG and TRAP Filtering Within the <Package> there contains: Additional Information A valid <PackageID> sub element providing the drivernumber must be present. The <IsActive> element value true or TRUE indicates if this package information must be used or ignored. Multiple <Event> elements can be provided within each package element. At least one sub element <EVENT > is required. One <MatchString> sub element value is used to match relevant events. Note a.* matches all messages, while an empty value ignores all messages. One <NegativeMatchString> sub element value indicates that if this match occurs, ignore the event. One <PullConfig> value of 1 indicates to setup a configuration pull if a match successfully occurred with a message, or a simple match to read changes by data, or for additional purposes in the future. Any number of <ChangedBy> regular expressions is matched to extract the username, if present in the message. You can disable the use of an xml-based event configuration by setting the <IsActive> element value to false. If the package configuration for a device class is not present, or if the <IsActive> is set to false, the Network Configuration Manager fallbacks to the old mechanism of letting the driver identify config change events. This may hamper performance, but would enable complex message parsing that can be completed more easily in DASL. The syslog event xml must be named. *SysLog.*, and the trap event xml must be named.*trap.* All xmls are objectified in memory by commmgr. Some device syslog xmls, such as for NetScreen, have %% run parameters that users need to change, and set the xml IsActive to true. Device Server Configuration on page 33 provides more information. Additional Information 23

24 Customizing Event SYSLOG and TRAP Filtering 24 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

25 CHAPTER 6 Changing the Syslog Message Parsing This chapter presents this topic: Editing syslog.xml Changing the Syslog Message Parsing 25

26 Changing the Syslog Message Parsing Editing syslog.xml The Syslog message parsing in the Network Configuration Manager can be changed so it parses a new or different Syslog message format. In the Network Configuration Manager, the Syslog message formats are externalized in the XML file VOYENCE_HOME/syslog.xml. The format of the syslog.xml content is as follows: <SysLog> <SysLogFormats> <SysLogFormat> <MatchString>[Place regular expression here]</matchstring> <Group>1</Group> </SysLogFormat> </SysLogFormats> </SysLog> Multiple SysLogFormat elements can be added. Each SysLogFormat element can have one MatchString element, but multiple Group Elements. The NCM_CommMgr daemon uses the match strings and group to perform a regular expression search, and uses the results to locate known devices as the source of the Syslog message. Any change to the syslog.xml file requires a restart of NCM_CommMgr. This can be done by restarting the voyence daemon on Red Hat Enterprise Linux 4 or 5, or Solaris 10, or restarting the NCM_CommMgr service on Windows Server Note: If no known device is found using the above steps, the algorithm falls back, and uses the standard message format for parsing. 26 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

27 CHAPTER 7 Use Cases: Using the custompackage Folder/Directory This chapter presents these topics: Case 1: Make Changes to the Driver File in.dasl or.inc (Implementation Only) Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) Case 3: SEARCHORDER= Case 4: Application interface Changes Use Cases: Using the custompackage Folder/Directory 27

28 Use Cases: Using the custompackage Folder/Directory Case 1: Make Changes to the Driver File in.dasl or.inc (Implementation Only) 1. Make Changes to driver file.dasl or.inc (only Implementation change), based on SEARCHORDER 1. For example, if you want to change cisco/ios/stdfuncs.inc. 2. If VOYENCE_HOME/custompackage/cisco/ios directory is not present, you must create this directory. If the cisco/ios/stdfuncs.inc was already present in the custompackage, modify the file. 3. If not already present, 4. copy VOYENCE_HOME/package/cisco/ios/stdfuncs.inc to VOYENCE_HOME/custompackage/cisco/ios/stdfuncs.inc. If this file is present, continue with step Make modifications to VOYENCE_HOME/custompackage/cisco/ios/stdfuncs.inc, and then 6. Save the file. 7. Restart the device server services. 8. Test the new functionality from the application, or test, based on the changes made. Case 2: Make Changes to the Driver File.dasl or.inc (Interface Change) 1. Make changes to driver file.dasl or.inc (Interface Change).SEARCHORDER This is similar to Use Case 1, except that if the change is being made to a function signature that requires many other caller related driver sources to change, you must ensure that all changes are appropriately made into the custompackage directory. 3. In most cases, making interface changes to functions is recommended only if needed. If changes are made, make sure to only add default parameters. For example: termconnect(var usemechanism,var port=23,var userprompted=false, var cutthru=false,var uid="undefineduserid",var pwd=undefinedpassword"); needs to add a new parameter to the end, as example: forward termconnect(var usemechanism,var port=23,var userprompted=false, var cutthru=false,var uid="undefineduserid",var pwd="undefinedpassword",var retrycount=5); 28 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

29 Use Cases: Using the custompackage Folder/Directory Case 3: SEARCHORDER=2 SEARCHORDER=2 (IGNORECUSTOMPACKAGE) Refer to step 3 in Using the VOYENCE_HOME/custompackage directory on page 14 for instructions. With this SEARCHORDER, setting changes and files in the custompackage directory are totally ignored. This SEARCHORDER is used when a new release was just installed, and all custom changes were included in the new release. There is no need for custompackage changes when you installed a new release, and all custom changes are included in the new release. Note: This has the same impact as completely deleting the custompackage directory contents. Case 4: Application interface Changes These changes include changes to the.pkg files, and other xmls that contain Application Server/Device Server interface information. For example, if OS support is added to a driver onsite to enable the same driver, the xml attribute in.pkg <OSUpgrade supported="true"> is added, and set to True. In this case, this.pkg must be placed under the custompackage/pkgxml directory on the Application Server, and the controldaemon service must then be restarted. Case 3: SEARCHORDER=2 29

30 Use Cases: Using the custompackage Folder/Directory 30 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

31 CHAPTER 8 Quick Driver Tool This chapter presents these topics: Quick Driver tool Accessing the Quick Driver tool Quick Driver Tool 31

32 Quick Driver Tool Quick Driver tool The Quick Driver tool is a wizard-based tool that allows you to create a read-only device driver through a series of steps. This tool is embedded as part of the Network Configuration Manager (NCM) application. Note: The capability of the Quick Driver tool is dependent on the capabilities of the device. The read-only device driver created by Quick Driver tool can perform the following tasks: Discover devices using SNMP and/or terminal Pull model, operating systam version and serial number using SNMP or terminal Pull interfaces, routes, arp, and entity-mib hardware using SNMP Pull text-based running and startup configurations using terminal, TFTP, FTP, and SCP Handle SNMP traps and syslog messages Send termlets to the device Send six basic quick commands to the device Open cut-through sessions to the device Accessing the Quick Driver tool To access the Quick Driver tool: 1. Go to address>:8080/qadd where <IP address> is the IP address of the Ionix NCM application server. Login screen appears. 2. Type your System Management Console application username and password. Click Login. 3. Follow the instructions in the wizard to create a read-only device driver. The embedded help in the Quick Driver tool provides more information on creating a read-only device driver. 32 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

33 APPENDIX A Device Server Configuration This appendix presents these topics: Important Notes CiscoPIXFirewallSysLog.xml CiscoPIXFirewallTrap.xml Additional examples for XMLs Device Server Configuration 33

34 Device Server Configuration Important Notes Note the following: In most cases, a single event sub element suffices, but multiple events can be provided, as shown for the pix driver. It is expected that Regular Expressions (RegEx) are used as a best practice for the following values: <MatchString> <NegativeMatchString> <ChangedBy> Caveat: To keep xmls uncomplicated, one of the limitations is that currently the ANDing of <MatchString> as a match is not provided. However, this should very rarely be needed if proper regular expressions are used. Also, fallback to DASL is available. NetScreen SysLog xml is disabled by default (fallback to dasl script occurs). Replace the %DEVICESERVERIPADDR% variable with the actual value of the Device Server IP Address, and enable by changing the value of the <IsActive> variable to true before use. CiscoPIXFirewallSysLog.xml <SysConfig> <Package> <IsActive>true</IsActive> <PackageID>10</PackageID> <Event> <MatchString>SYS-5-CONFIG</MatchString> <PullConfig>1</PullConfig> </Event> <Event> <MatchString>PIX </MatchString> <PullConfig>1</PullConfig> </Event> <Event> <MatchString>PIX </MatchString> <ChangedBy>User '(.*)' executed the 'enable' command</changedby> </Event> <Event> <MatchString>ASA :.*configure terminal.</matchstring> <ChangedBy>User '(.*)' executed the 'configure terminal' command</changedby> <PullConfig>1</PullConfig> </Event> <Event> <MatchString>ASA :.*configure terminal.</matchstring> 34 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

35 Device Server Configuration <ChangedBy>User '(.*)' executed the 'configure terminal' command</changedby> <PullConfig>1</PullConfig> </Event> <Event> <MatchString>FWSM :.*configure terminal.</matchstring> <ChangedBy>User '(.*)' executed the 'configure terminal' command</changedby> <PullConfig>1</PullConfig> </Event> CiscoPIXFirewallTrap.xml Additional examples for XMLs <TrapConfig> <Package> <IsActive>true</IsActive> <PackageID>10</PackageID> <Event> <MatchString> *configure t</matchstring> <PullConfig>1</PullConfig> </Event> </Package> </TrapConfig> This configuration is disabled. <IsActive>false</IsActive> must be enabled with the %DEVICESERVERIPADDR% substituted with devserver ip by the customer. Until then, fallback would be enabled to DASL. <SysConfig> <Package> <PackageID>21</PackageID> <IsActive>false</IsActive> <Event> <MatchString>system-information-00767: System configuration saved by.* via</matchstring> <ChangedBy>system-information-00767: System configuration saved by (.*) via</changedby> <PullConfig>1</PullConfig> </Event> <Event> <MatchString>system-warning-00515: Admin user.* has logged</matchstring> <ChangedBy>system-warning-00515: Admin user (.*) has logged</changedby> <NegativeMatchString>from %DEVICESERVERIPADDR%</NegativeMatchString> <PullConfig>1</PullConfig> </Event> </Package> This matches all syslog messages for pulls <SysConfig> <Package> <PackageID>100</PackageID> <IsActive>true</IsActive> <Event> CiscoPIXFirewallTrap.xml 35

36 Device Server Configuration <MatchString>.*</MatchString> <PullConfig>1</PullConfig> </Event> </Package> This filters out all messages; a <MatchString> is empty. <SysConfig> <Package> <PackageID>100</PackageID> <IsActive>true</IsActive> <Event> <MatchString></MatchString> <PullConfig>1</PullConfig> </Event> </Package> </SysConfig> This is equivalent to <IsActive>false</IsActive> as there are no events. <SysConfig> <Package> <IsActive>true</IsActive> <PackageID>2000</PackageID> <IsActive>true</IsActive> </Package> </SysConfig> This is configured for Generic RME driver Notice the devicename. This is used to extract the device name from the EMS message <TrapConfig> <Package> <IsActive>true</IsActive> <PackageID>2000</PackageID> <Event> <DeviceName> :(.*)$</DeviceName> <MatchString> </MatchString> <NegativeMatchString>User initiated archive update</negativematchstring> <ChangedBy> :(.*)$</ChangedBy> <PullConfig>1</PullConfig> </Event> 36 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

37 GLOSSARY This glossary contains terms related to disk storage subsystems. Many of these terms are used in this manual. D DASL DSR Device Access Scripting Language Device Support Release G GUI Graphical User Interface I IP Internet Protocol. This is a network layer protocol in the Internet protocol suite and is encapsulated in a data link layer protocol (e.g., Ethernet). O OS Operating System R RegEx RME Regular Expression Resource Manager Essentials (CISCO) U UNIX A multi-user, multitasking computer operating system V VPN Virtual Private Network X XML extensible Markup Language: a simplified version of SGML that can be used, esp. on the World Wide Web, to create a tagging scheme that allows elements of a document to be marked according to their content rather than their format. EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide 37

38 Glossary 38 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide

39 INDEX A About this Manual 10 Additional examples for xmls 35 C Case 1 Make Changes to the Driver File in.dasl or.inc (Implementation Only) 28 Case 2 Make Changes to the Driver File.dasl or.inc (Interface Change) 28 Case 3 SEARCHORDER=2 29 Case 4 Application interface Changes 29 Change Prompt Example 19 Changing the Syslog Message Parsing 25 CiscoPIXFirewallSysLog.xml 34 CiscoPIXFirewallTrap.xml 35 Compatibility 10 D Device Drivers with XML Prompt Support 19 E EMC online support website 5 Explanation of XML Elements 22 extract the device name from the EMS message 36 L LABNET 19 Q Quick Driver tool 32 Accessing the Quick Driver tool 32 S syslog messages for pulls 35 U Usage 22 V VOYENCE_HOME/package/pkgxml/event/ directory. 22 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide 39

40 Index 40 EMC Ionix Network Configuration Manager Device Services Support (DSr) Version 13.0 Configuration Guide