Cisco TEO Adapter Guide for Terminal Adapter

Transcription

1 Cisco TEO Adapter Guide for Terminal Adapter Release 2.3 April 2012 Americas Headquarters Cisco Systems, Inc. 170 West Tasman Drive San Jose, CA USA Tel: NETS (6387) Fax: Text Part Number:

2 THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS. THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY. The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB s public domain version of the UNIX operating system. All rights reserved. Copyright 1981, Regents of the University of California. NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED AS IS WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE. IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1110R) Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental Cisco Systems, Inc. All rights reserved.

3 CONTENTS New and Changed Information vii Preface ix Organization ix Conventions x Product Documentation xi Documentation Formats xi Guides and Release Notes xi Online Help xi Open Source License Acknowledgements xi Obtaining Documentation and Submitting a Service Request xi CHAPTER 1 Configuring Terminal Adapter 1-1 Verifying System Prerequisites 1-2 Adapter System Requirements 1-4 Supported Cisco Devices for TEO Content 1-4 Routers 1-4 Switches 1-5 Appliances 1-6 Configuring SSH Version 2.0 Support for Cisco IOS Devices 1-7 Accessing Terminal Adapter Properties 1-7 Configuring an Expect Template 1-8 Enabling the FIPS-Compliance JCE Provider 1-12 Configuring Default Host-Based Authentication Keys 1-12 Selecting a Private Key 1-14 Selecting a Public Key 1-15 Viewing Terminal Adapter Prerequisites 1-16 Viewing Terminal Adapter-Supported Objects 1-17 Viewing Terminal Adapter History 1-19 CHAPTER 2 Managing Terminal Runtime Users 2-1 Accessing Definitions Runtime users 2-2 Runtime User Details Pane 2-3 Viewing Runtime User Properties 2-3 iii

4 Contents Defining a Public-key Authenticated Admin Runtime User Account 2-4 Defining a Runtime Admin User 2-6 Defining a Runtime User Account 2-8 Defining a Windows User 2-10 Managing Runtime User Definitions 2-12 Modifying a Runtime User Record 2-12 Deleting a Runtime User 2-12 Viewing Used By Properties 2-12 Viewing Runtime User History 2-13 CHAPTER 3 Managing Terminal Targets 3-1 Accessing Definitions Targets 3-2 Viewing Target Properties 3-3 Target Algorithms 3-4 Target s 3-5 Common Regular Expressions 3-5 Defining a Network Device Module Target 3-6 Defining a Terminal Target 3-13 Defining a Unix/Linux System Target 3-22 Managing Target Definitions 3-30 Enabling a Target 3-30 Disabling a Target 3-30 Modifying Targets 3-31 Configuring Total Concurrent Sessions on a Target 3-31 Adding an Expect Parameter 3-32 Removing an Expect Parameter 3-34 Modifying Target Interaction Pattern Properties 3-34 Defining Target Criteria 3-36 Comparison Operators 3-37 Inserting a Target Variable Reference 3-38 Deleting a Target 3-40 Viewing Network Module Device Targets 3-41 Viewing Target Open Sessions 3-41 Viewing Member Of Properties 3-42 Viewing Extended Properties 3-43 Modifying Extended Property Values 3-43 Viewing Used By Properties 3-44 Viewing Targets History 3-44 iv

5 Contents CHAPTER 4 Using Terminal Adapter Activities 4-1 Terminal Adapter Activities 4-2 Common Wildcard Expressions 4-2 Defining Secure Shell (SSH) Activities 4-3 Defining the Execute Unix/Linux SSH Command Activity 4-3 Defining the Execute Unix/Linux SSH Script Activity 4-10 Defining the Get File Activity 4-13 Defining the Put File Activity 4-17 Defining Terminal Activities 4-21 Defining the Close Terminal Session Activity 4-21 Defining the Execute Terminal Command(s) Activity 4-24 Defining the Open Terminal Session Activity 4-28 Managing Activity Definitions 4-32 Modifying a Terminal Adapter Activity 4-32 Inserting an Activity Variable Reference 4-33 Adding a Script Argument 4-35 Modifying a Script Argument 4-35 Removing a Script Argument 4-35 Script Argument Syntax 4-36 Script Argument Example 4-36 Adding a Remote File to Get File Activity 4-37 Adding a Local File to Put File Activity 4-37 Removing Files from Activity 4-38 Removing a Single File 4-38 Removing all Files 4-38 Viewing Activity Instance Information 4-39 Viewing Activity Status 4-39 Status Indicators 4-39 Color Indicators 4-39 Viewing Activity Instance Properties 4-40 Viewing Close Terminal Session Output 4-40 Viewing Executed Terminal Command Output 4-41 Viewing Executed Unix/Linux SSH Command Output 4-42 Viewing Executed Unix/Linux SSH Script Output 4-43 Getting Exit Status when Executing Unix/Linux SSH Scripts 4-44 Viewing Get File Output 4-45 Viewing Open Terminal Session Output 4-46 Viewing Put File Output 4-47 v

6 Contents CHAPTER 5 Troubleshooting Terminal Adapter 5-1 Correcting Open Session Activity Timeout Error 5-2 Error 5-2 Solution 5-2 Activity Output does not match Expect Prompts 5-3 Error 5-3 Solution 5-3 Expect Prompt Command Error 5-4 Error 5-4 Solution 5-4 Target Connection Pattern Prompt Prefix Error 5-5 Error 5-5 Solution 5-5 Execute Terminal Command Activity Timed Out 5-6 Error 5-6 Solution 5-7 I NDEX vi

7 New and Changed Information The Terminal Adapter for Cisco Tidal Enterprise Orchestrator 2.3 provides host-based and public key authentication and improves upon the existing expects functionality. The authentication enhancement allows users to apply host-based authentication from the adapter level. Users can also apply public key authentication on the device target level. In TEO 2.3, users can now create expect templates for their login expects. Expect templates allow users to leverage existing login expect sequences when applying expects to a device target or activity. The Terminal adapter is also now FIPS-compliant and allows user to enable FIPS-compliant algorithms. TEO 2.3 provides network device module target so that the user can run Open Terminal Session, Execute Terminal Commands and Close Terminal Session activities against them. The following sections have been included and/or updated in this guide to include the features that have been implemented for Cisco Tidal Enterprise Orchestrator 2.3. Table 1 TEO 2.3 Feature Changes Feature Location Expect templates allow reusable login expect sequences for device targets and activities. Terminal adapter is now FIPS-compliant and allows users to enable FIPS-compliant algorithms. Host-based authentication on the adapter level allows users to set up default public key and private key authentication. Public-key authenticated admin user provides the user credentials required to allow public key authentication and an administrative password. Network device module target configures the connection information for the network device module target. Execute Terminal Command activity no longer allows user to indicate whether the string text entered was encrypted. The activity also allows users to indicate whether the command ends special characters. Get/Put files activities contain slight modifications to the layout of the activity property page and also requires local window user credential to access local file systems. Chapter 1, Configuring Terminal Adapter Chapter 1, Configuring Terminal Adapter Chapter 1, Configuring Terminal Adapter Chapter 2, Managing Terminal Runtime Users Chapter 3, Managing Terminal Targets Chapter 4, Using Terminal Activities vii

8 New and Changed Information viii

9 Preface Revised: April 2012, The Terminal adapter provides the functionality to execute commands, scripts and session-based activities against a system or network device using SSH or Telnet. While SSH is more secure than telnet, many environments use a telnet connection and using a SSH connection against such devices will not be possible. The Terminal adapter was improved to allow users the flexibility to execute against those devices. This guide is intended to provide information on using the objects provided by the Terminal adapter including instructions for viewing Terminal adapter properties, defining device targets and activities, completing the property pages for each specific activity, and viewing the activity results. Organization The information is organized into the following chapters. Chapter 1 Configuring Terminal Adapter Provides information on the Terminal adapter properties Chapter 2 Managing Terminal Runtime Users Provides information on creating and managing runtime user accounts Chapter 3 Managing Terminal Targets Provides information on viewing defined targets that are available for execution by a process. Chapter 4 Chapter 5 Using Terminal Adapter Activities Troubleshooting Terminal Adapter Contains information on defining and launch Terminal activities. Provides troubleshooting tips for process failures ix

10 Preface Conventions This guide uses the following conventions: Convention bold font italic font Indication Commands and keywords and user-entered text appear in bold font. Document titles, new or emphasized terms, and arguments for which you supply values are in italic font. [ ] Elements in square brackets are optional. {x y z } Required alternative keywords are grouped in braces and separated by vertical bars. [ x y z ] Optional alternative keywords are grouped in brackets and separated by vertical bars. string A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. courier font Terminal sessions and information the system displays appear in courier font. < > Nonprinting characters such as passwords are in angle brackets. [ ] Default responses to system prompts are in square brackets.!, # An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. Note Means reader take note. Tip Means the following information will help you solve a problem. Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data. Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph. Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury. x

11 Preface Product Documentation Documentation Formats Documentation is provided in the following electronic formats: Adobe Acrobat PDF files Online help You must have Adobe Reader installed to read the PDF files. Adobe Reader installation programs for common operating systems are available for free download from the Adobe Web site at Guides and Release Notes You can download the TEO product documentation from Cisco.com. Release Notes can be found on Cisco.com and the product CD. Online Help Online help is available and can be accessed using the following methods: Click Help on any dialog box in the application to open the help topic in a pane to the right of the dialog box. In the Tidal Enterprise Orchestrator console: Click the Help Pane tool on the toolbar to open the help topic in a pane to the right of the Results pane. Click Help on the menu bar. Open Source License Acknowledgements Licenses and notices for open source software used in Cisco Tidal Enterprise Orchestrator can be found in the Open Source License Acknowledgements on Cisco.com. If you have any questions about the open source contained in this product, please external-opensource-requests@cisco.com. Obtaining Documentation and Submitting a Service Request For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What s New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at: Subscribe to the What s New in Cisco Product Documentation as a RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0. xi

12 Preface xii

13 CHAPTER 1 Configuring Terminal Adapter The Terminal adapter properties dialog boxes displays general information about the functionality provided by the adapter, version number, release date and install date, any prerequisites, and the history of changes made to the adapter. This chapter provides instructions for viewing and configuring Terminal adapter properties: Verifying System Prerequisites, page 1-2 Supported Cisco Devices for TEO Content, page 1-4 Configuring SSH Version 2.0 Support for Cisco IOS Devices, page 1-7 Accessing Terminal Adapter Properties, page 1-7 Configuring an Expect Template, page 1-8 Configuring Default Host-Based Authentication Keys, page 1-12 Viewing Terminal Adapter Prerequisites, page 1-17 Viewing Terminal Adapter-Supported Objects, page 1-18 Viewing Terminal Adapter History, page

14 Verifying System Prerequisites Chapter 1 Configuring Terminal Adapter Verifying System Prerequisites Before installing Tidal Enterprise Orchestrator (TEO), it is recommended that you verify that your system meets the minimum hardware and software requirements. To manually check your system setup, launch the Prerequisite Checker on the Tidal Enterprise Orchestrator Installation dialog box to verify. For additional information on the TEO system requirements, refer to the Cisco TEO Installation and Administration Guide. To verify prerequisites: Step 1 Insert the Enterprise Orchestrator installation CD into the CD-ROM drive or double-click the Setup.exe file. The Tidal Enterprise Orchestrator Installation dialog box displays. Figure 1-1 Installation Dialog Box Setup Tasks Tab 1-2

15 Chapter 1 Configuring Terminal Adapter Verifying System Prerequisites Step 2 On the Setup Tasks tab, click Check Prerequisites. The Prerequisites Checker dialog box displays. Figure 1-2 Tidal Enterprise Orchestrator Prerequisites Checker Dialog Box Step 3 From the drop-down list, select one of the following options to verify that the computer meets the requirements for the selected installation: Requirements for complete install (automation server, client, and Web Console) Requirements for automation server and client Requirements for client only Requirements for Web Console only Requirements for automation packs (and adapters) After a quick evaluation scan runs on the machine, the Prerequisites Checker dialog box displays the results in the following columns: Column Item Status Minimum Value Detected Value Software or hardware item required for installation Indicates whether the system has the required software or hardware item for the product (Information, Passed, Warning) Note If the system does not pass certain requirements, correct the issue, and click Refresh to verify the prerequisite status before continuing with the installation process. Denotes the minimum system requirement for the item Displays the actual software or hardware item in the system 1-3

16 Supported Cisco Devices for TEO Content Chapter 1 Configuring Terminal Adapter Step 4 Step 5 To view details about the displayed results, highlight the appropriate item in the Results pane, and then review the information in the Explanation pane. After verifying the status of the system requirements, click Close to close the Prerequisites Checker dialog box. Note For additional information on installing TEO, refer to the Cisco TEO Installation and Administration Guide. Adapter System Requirements This section provides the system requirements for the Terminal adapter. To verify whether the adapter requirements have been met, see Viewing Terminal Adapter Prerequisites, page Table 1-1 Minimum Adapter System Requirements Adapter Terminal Adapter Component Java 1.6 or higher Supported Cisco Devices for TEO Content The following section is a breakdown of the Cisco devices supported by the content provided by TEO 2.3 to provide cloud and network support automation functionality. While specific TEO content only works with the following devices, TEO 2.3 can work against any TELNET or SSH 2.0 device. Routers The following table contains the list of supported Cisco routers by TEO. Device Cisco 2800 Series Integrated Services Routers Cisco 7200 Series Routers Designed for wire-speed delivery of highly secure concurrent services and can accommodate multiple T1/E1 connections Learn more on the Cisco 2800 Series Integrated Services Router Data Sheet. Universal services aggregation router for enterprise and service provider edge applications Learn more on the Cisco 7200 Series Routers Overview Data Sheet. 1-4

17 Chapter 1 Configuring Terminal Adapter Supported Cisco Devices for TEO Content Device Cisco 7600 Series Routers Cisco PIX 515E Security Appliance Offers integrated, high-density Ethernet switching, carrier-class IP/MPLS routing, and 10-Gbps interfaces Learn more on the Cisco 7600 Series Data Sheet. Provides robust user and application policy enforcement, multi-vector attack protection, and secure connectivity services through a wide range of rich security and networking services Learn more on the Cisco PIX 515E Security Appliance Data Sheet. Switches The following table contains the list of supported Cisco series switches by TEO. Device Cisco Catalyst 2950 Series Switches Fixed-configuration, stackable standalone switch that provides wire-speed Fast Ethernet and Gigabit Ethernet connectivity Learn more on the Cisco Catalyst 2950 Series Switches Data Sheet. Cisco Catalyst 3750 Series Switches Eases deployment of converged applications and adapts to changing business needs by providing configuration flexibility, support for converged network patterns, and automation of intelligent network services configurations Learn more on the Cisco Catalyst 3750 Series Switches Data Sheet. Cisco Catalyst 4500 Series Switches Delivers a high-performance, highly secure, and mobile user experience for enterprise wiring closets, access and core layers through innovations in collaboration, security, resiliency, and EnergyWise Learn more on the Cisco Catalyst 4500 Series Switches Data Sheet. Cisco Catalyst 6500 Series Switches Delivers secure, converged, end-to-end services, from the wiring closet to the core network, the data center, and the WAN edge Learn more on the Cisco Catalyst 6500 Series Switches Data Sheet. Nexus 1000V Series Switches Ensures consistent, policy-based network and security services to all virtual machines (VMs) in your data center Learn more on the Cisco Nexus 1000V Series Switches Data Sheet. Note TEO does not support the XML management interface against SSH at this time. 1-5

18 Supported Cisco Devices for TEO Content Chapter 1 Configuring Terminal Adapter Device Nexus 2000 Series Fabric Extenders Simplifies data center architecture and operations to meet customers' business and application needs Learn more on the Cisco Nexus 2000 Series Fabric Extenders Data Sheet. Nexus 5000 Series Switches Nexus 7000 Series Switches Note TEO does not support the XML management interface against SSH at this time. Helps transform the data center with innovative, standards-based, multilayer, multiprotocol, and multipurpose Ethernet-based fabric Learn more on the Cisco Nexus 5000 Series Switches Data Sheet. Note TEO does not support the XML management interface against SSH at this time. Modular switching system designed to deliver 10 Gigabit Ethernet and unified fabric in the data center Learn more on the Cisco Nexus 7000 Series Switches Data Sheet. Note TEO does not support the XML management interface against SSH at this time. Appliances The following table contains the list of supported Cisco appliances by TEO. Device Cisco ACE Application Control Engine Module Cisco ASA 5580 Adaptive Security Appliances Cisco Catalyst 6500 Series Network Analysis Module Cisco Catalyst 6500 Series Firewall Services Module Is a next-generation load-balancing and application-delivery solution Learn more on the Cisco ACE Application Control Engine Module Data Sheet. Delivers multigigabit security services for large enterprise, data center, and service-provider networks in a robust, 4-rack-unit form factor Learn more on the Cisco ASA 5500 Series Adaptive Security Appliances Data Sheet. Offers unparalleled visibility into network performance, and helps you simplify the application delivery challenges of today's dynamic, evolving global organizations Learn more on the Cisco Catalyst 6500 Series Network Analysis Module. A high-speed, integrated firewall module which provides the fastest firewall data rates in the industry Learn more on the Cisco Catalyst 6500 Series Firewall Services Module Data Sheet. 1-6

19 Chapter 1 Configuring Terminal Adapter Configuring SSH Version 2.0 Support for Cisco IOS Devices Configuring SSH Version 2.0 Support for Cisco IOS Devices To properly execute Cisco IOS processes and activities against the Terminal adapter, the IOS device cannot run using SSH v1.0. The IOS devices should be configured to run SSH v2.0. The Secure Shell Version 2 Support feature allows users to configure Secure Shell (SSH) Version 2. Before configuring SSH, download the k9 (Triple Data Encryption Standard [3DES]) software image from Cisco IOS Release 12.3(4)T, 12.2(25)S, or 12.3(7)JA onto your router. For additional information on configuring IOS devices for SSH v2.0 support, see Secure Shell Version 2 Support on the Cisco website. Accessing Terminal Adapter Properties Users can access the Terminal adapter properties from the Administration Adapters view in the console. To view adapter properties: Step 1 On the Administration Adapters view, highlight Terminal Adapter, and use one of the following methods: Right-click and choose Properties. -or- On the Details pane, click the hyperlink name on any of the tabs. The Terminal Adapter Properties dialog box displays. Figure 1-3 Terminal Adapter Properties Dialog Box General Tab 1-7

20 Configuring an Expect Template Chapter 1 Configuring Terminal Adapter The General tab displays the following information about the adapter: Field Name Type Company Version Release date Install date Name of the adapter Object type Brief overview of the adapter Name of company that created or supplied the adapter Version number of the adapter Date and time the adapter was available in the product Date and time the adapter was installed Step 2 Review the properties and click OK to close the dialog box. Configuring an Expect Template Because creating Terminal targets can be complex, the expect template provides users with limited knowledge of expects a simpler method to complete the target configuration properties. Expect templates contain default configuration sequence of expects and elevated privilege command expects. The Expect Template tab on the Terminal Adapter dialog box displays the list of default expect template configurations that have been created using the Expect Templates dialog box. From this tab, users can create, modify, and delete expect templates. Expect templates can be imported and exported just like other objects in an automation pack. Imported expect templates from an automation pack can only be modified by the author of that automation pack. A TEO content-author can only export those expect templates created by that content author. To configure an expect template: Step 1 Step 2 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Expect Templates tab to continue. 1-8

21 Chapter 1 Configuring Terminal Adapter Configuring an Expect Template Figure 1-4 Terminal Adapter Properties Dialog Box Expect Templates Tab Step 3 To create an expect template, click New > Expect Template. The New Expect Template Properties dialog box displays. Figure 1-5 New Expect Template Properties Dialog Box General Tab Step 4 On the General tab, enter the following information: Field Display name Type Name of the expect template Display-only. Type of expect template 1-9

22 Configuring an Expect Template Chapter 1 Configuring Terminal Adapter Field Owner The owner of the object. This is typically the creator of the object. Click Browse to launch the Select User or Group dialog box and change the owner. Brief description of the expect template Step 5 Click the Expect Template tab to configure the default expect values. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 1-6 New Expect Template Properties Dialog Box Expect Template Tab Step 6 Complete the following information for the connection patterns. Field Prompt pattern Error pattern Admin prompt pattern Enter the system prompt pattern in regular expression. Enter the error message pattern in regular expression. Enter the admin prompt pattern in regular expression. 1-10

23 Chapter 1 Configuring Terminal Adapter Configuring an Expect Template Note Click the Expression arrow to the right of the Reference icon to add a regular expression the field. For additional information on regular expressions, see Common Regular Expressions, page 3-5. Step 7 To modify the list of login expects, click the following buttons, as necessary. Button Add Edit Remove Move Up Move Down Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. Note See Adding an Expect Parameter, page Highlight the appropriate item and click Remove to remove the item from the list. Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. Note Removing an Expect Parameter, page Highlight the appropriate item and then click this button to move the item up list. Highlight the appropriate item and then click this button to move the item down list. Step 8 To elevate the privilege command for login expects: Field Elevating Privilege command Elevating Privilege expects Check this check box and in the text field, enter the command or select the reference variable containing the command to elevate the privilege for the expect. Use this section to view and/or define the login expect sequence for the elevating privilege command expects. To modify the list of expects, see See Adding an Expect Parameter, page 3-32or Removing an Expect Parameter, page Step 9 Click OK to complete the expect template definition. The following information is displayed on the Expect Templates tab. Column Display Name Automation Pack Type Id Name of the expect template of the expect template Name of the automation pack associated with the expect template Type of object ID number for the expect template 1-11

24 Configuring Default Host-Based Authentication Keys Chapter 1 Configuring Terminal Adapter Step 10 Click OK to close the dialog box. Enabling the FIPS-Compliance JCE Provider The Terminal Adapter ships with a FIPS-compliant Java Crypto Extension (JCE) provider to connect to FIPS-compliant network devices, such as the ACS 5.2 server. This provider includes encryption algorithms that may not be supported by Java that are also useful in high-security scenarios. To enable the FIPS-compliance algorithm: Step 1 Step 2 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Advanced tab to continue. Figure 1-7 Terminal Adapter Properties Dialog Box Advanced Tab Step 3 Step 4 Under FIPS-Compliance, check the Only use FIPS-compliant encryption algorithm check box to indicate that only FIPS-compliant encryption algorithms should be used by the Terminal adapter. If this check box is checked, then any SSH targets that uses an unsupported algorithm will not be accessible in TEO. Click OK to close the dialog box. Configuring Default Host-Based Authentication Keys Users can define default host public and private keys on the Advanced tab of the Terminal Adapter dialog box. This tab allows users to select a specific private key for the target. The private key will be used for host-based authentication if a target does not specify its own keys. The Authentication tab on a Target dialog box indicates whether the target should allow authentication based on the host system of the user and the user name on the remote host system. To configure default host-base authentication keys: Step 1 Step 2 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Advanced tab to continue. 1-12

25 Chapter 1 Configuring Terminal Adapter Configuring Default Host-Based Authentication Keys Figure 1-8 Terminal Adapter Properties Dialog Box Advanced Tab Step 3 On the Advanced tab, configure the authentication keys. Field Private key Public key Public key file content To the right of the display-only field, click Browse to launch the Load Private Key dialog box to select a private key. See Selecting a Private Key, page To the right of the display-only field, click Browse to launch the Load Public Key dialog box to select a public key. See Selecting a Public Key, page Enter the SSH public key request message to the remote SSH server that will authenticate the request against the stored public key. Users can use this public key information to configure host-based authentication on the remote SSH server, and the remote SSH server will authenticate the request against the stored public key. Step 4 Click OK to close the dialog box. 1-13

26 Configuring Default Host-Based Authentication Keys Chapter 1 Configuring Terminal Adapter Selecting a Private Key If OpenSSH is installed, the key pair is generated by the command line tool "ssh-keygen." The default location of the file is under the unix user's home directory: ~/.ssh/id_rsa Copy the file to a location where it is accessible from the TEO server, then follow the steps to load the private key. To select a private key: Step 1 Step 2 Step 3 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Advanced tab to select the private key to authenticate the public key. On the Private Key field, click Browse. The Load Private Key dialog box displays. Figure 1-9 Load Private Key Dialog Box 1-14

27 Chapter 1 Configuring Terminal Adapter Configuring Default Host-Based Authentication Keys Step 4 On the Load Private Key dialog box, select the private key file to be used to authenticate the public key. Field Passphrase to the private key file Select a private key file Check this check box and in the text field, enter the passphrase to be used to validate the private key file. The passphrase is used to protect the private key file when the private key is generated. To the right of the display-only field, click Browse to launch the Open dialog box to locate the private key file. The most commonly used private key file format is "RSA PRIVATE KEY." The private key file should reside on the same machine as the TEO server. The default location of the file is under the unix user's home directory: ~/.ssh/id_rsa The content of the private key file will be displayed after the passphrase is validated against the private key file content. Step 5 Click OK to close the dialog box. The private key displays on the Private key field on the Advanced tab. Selecting a Public Key A public key is a value provided by some designated authority as an encryption key that, combined with a private key derived from the public key, can be used to effectively encrypt messages and digital signatures. Use the Load Public Key dialog box to select a public key to be used by the Terminal adapter. To select a public key: Step 1 Step 2 Step 3 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Advanced tab to select a public key. On the Public Key field, click Browse. The Load Public Key dialog box displays. 1-15

28 Configuring Default Host-Based Authentication Keys Chapter 1 Configuring Terminal Adapter Figure 1-10 Load Public Key Dialog Box Step 4 On the Load Public Key dialog box, select the public key file. Field Select a public key file To the right of the display-only field, click Browse to launch the Open dialog box to locate the public key file. Step 5 Click OK to close the dialog box. The public key displays on the Public key field on the Advanced tab. 1-16

29 Chapter 1 Configuring Terminal Adapter Viewing Terminal Adapter Prerequisites Viewing Terminal Adapter Prerequisites Use the Prerequisites tab to display the names and objects that are required by the Terminal adapter on the automation server. To view adapter prerequisites: Step 1 Step 2 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Prerequisites tab to view the prerequisites that is required by the adapter. Figure 1-11 Terminal Adapter Properties Dialog Box Prerequisites Tab 1-17

30 Viewing Terminal Adapter-Supported Objects Chapter 1 Configuring Terminal Adapter Step 3 Review the following information required by the adapter and click OK to close the dialog box. Column Name Importance State Minimum Value Detected Value Explanation Name of the required item for the supported adapter Indicates the importance of the prerequisite to the adapter Optional Required Indicates whether the system has the required software or hardware item for the adapter Satisfied Not satisfied Denotes the minimum system requirement for the item Displays the actual level (version) of the software/hardware item discovered on the automation server Displays the information related to the selected adapter requirement Viewing Terminal Adapter-Supported Objects Use the Provides tab to view the name and type of component for each item the Terminal adapter supports. To view adapter-provided objects: Step 1 Step 2 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Click the Provides tab to view the functionality that is provided by the adapter. 1-18

31 Chapter 1 Configuring Terminal Adapter Viewing Terminal Adapter-Supported Objects Figure 1-12 Terminal Adapter Properties Dialog Box Provides Tab Step 3 Review the list of objects and click OK to close the dialog box. 1-19

32 Viewing Terminal Adapter History Chapter 1 Configuring Terminal Adapter Viewing Terminal Adapter History Use the History tab to view a history of changes that have been made to the adapter. To view adapter history: Step 1 On the Administration Adapters view, highlight Terminal Adapter, right-click and choose Properties. The Terminal Adapter Properties dialog box displays. Figure 1-13 Terminal Adapter Properties Dialog Box History Tab Step 2 Click the History tab to view the changes made to the adapter. Column Created by Created time Time Change Type User The user name of the person who created the object The date and time the object was created The date and time the action occurred The action that occurred The user name or group that performed the action Information about the action that was performed Step 3 To view the audit history for a specific action, highlight the appropriate object, right-click and choose Properties. The Audit Properties dialog box displays. 1-20

33 Chapter 1 Configuring Terminal Adapter Viewing Terminal Adapter History Figure 1-14 Success Audit Properties Dialog Box Step 4 Review the display-only properties dialog box for information about system-related events that occurred and their status. Field Type Type of event logged by the system Success Audit Failure Audit Created By System-generated record, such as an error condition, or the user name of the person who initiated the process Created Time Date and time the event occurred Brief description of the event Step 5 Click OK to close the dialog box. 1-21

34 Viewing Terminal Adapter History Chapter 1 Configuring Terminal Adapter 1-22

35 CHAPTER 3 Managing Terminal Targets Using Terminal adapter targets simplifies specifying where certain processes, activities, or triggers will run. Different network devices issue different sequences of prompts during the login. The Terminal adapter allows users to create a TEO target to represent less standard devices via SSH or Telnet. The target can be defined once and reused in several processes. When upgrading from TEO 2.1 to TEO 2.3, please be advised that the Prompt Prefix field in the Terminal or Unix/Linux targets must be completed as it was not available in TEO 2.1. To properly run a Unix SSH script and command activities against Terminal adapter targets, TEO requires the Secured File Transfer Protocol (SFTP) to be enabled on the Unix/Linux system in order to run SSH Script and SSH Command activities. It is not needed for the SSH/Telnet Terminal Session activities. This chapter guides users through managing Terminal adapter targets. Accessing Definitions Targets, page 3-2 Defining a Network Device Module Target, page 3-6 Defining a Terminal Target, page 3-13 Defining a Unix/Linux System Target, page 3-22 Managing Target Definitions, page

36 Accessing Definitions Targets Chapter 3 Managing Terminal Targets Accessing Definitions Targets The Definitions Targets displays all the existing defined targets. You also use this view to create new targets, modify the properties of a target, and delete targets. To access the Targets view: On the Definitions workspace, select Targets. The Results pane displays. Figure 3-1 Definitions Targets Information about the target can be displayed in the following columns: Column Display name Enabled Type The name assigned to the target Indicates whether the target is enabled (True) or disabled (False). A disabled target is unavailable for execution. The type of target based on the associated adapter 3-2

37 Chapter 3 Managing Terminal Targets Accessing Definitions Targets Column Status Status Information Automation Pack Customizable Owner Last Modified Time Last Modified By Id Type Created Time Created By Indicates the status of the target. The status is used to determine whether the target is available or is not available for process or activity execution. Unknown Status of the target unknown Normal No known problems with this target Unreachable TEO is experiencing problems connecting to the target and executing activities Disabled Target is disabled and is not available for activity execution Detailed information regarding the target status and the reasons for target being unreachable Name of the automation pack associated with the target Indicates the customization setting for the object in the automation pack The user name of the person who created the target The time the target was last modified The user name of the person who last modified the target The unique identification number of the target definition A brief description of the target A brief overview of the target type The time at which the target was created The user name of the person who created the target Note For information on adding, removing, or sorting column headings on the display, see the Cisco Tidal Enterprise Orchestrator Reference Guide. Viewing Target Properties The property pages may display as display-only if the target definition is shipped as part of the product or the user does not have the appropriate rights. To view target properties: Step 1 On the Definitions Targets view, highlight the appropriate target, and use one of the following methods: Right-click and choose Properties. -or- On the Details pane, click the hyperlink name on any of the tabs. The Properties dialog box displays. The tabs displayed depend on the selected target. 3-3

38 Accessing Definitions Targets Chapter 3 Managing Terminal Targets Step 2 Click the appropriate tab to review the properties Tab General Connection Authentication Advanced Network Modules Open Sessions Member Of Extended Properties Used by History Displays general information about the target Displays the connection properties for the defined target Displays properties used to indicate the target uses host-based authentication and the private/public key for host-based authentication provided by the user. Displays the settings for the interaction patterns Displays the list of network modules assigned to the terminal target Displays information about sessions currently opened on the target and sessions waiting to be opened Displays the target groups associated with the defined targets Displays the list of all target properties defined for this target type Displays the objects referenced by the target Displays when the target was created or modified. The column also displays audit log entries that are relevant to the target. Step 3 Click OK to close the dialog box. Target Algorithms The following table displays the list of target algorithms that may display for an activity. Algorithm Choose the target with the specified name Choose all target that satisfies the specified criteria Runs the process on the member of the group specified in the Name to match text field. Select this option to execute the process on all targets defined by the criteria specified in the Target Selection dialog box. See Defining Target Criteria, page

39 Chapter 3 Managing Terminal Targets Accessing Definitions Targets Target s The following table provides a listing of the targets that are associated with the product. Target Network Device Module Terminal Unix/Linux System Configures the connection information for the network device module target See Defining a Network Device Module Target, page 3-6. Connection information used to access the device used for processes to run against. See Defining a Terminal Target, page Connection information for a Unix or Linux system that has a SSH server running See Defining a Unix/Linux System Target, page Common Regular Expressions The following table describes are commonly used special characters that display according to the selected activity. Character * Zero or more. Any single character + One or more ^ Beginning of line $ End of line < Beginning of word > End of word \n Line break [] Any one character in the set [^] Any one character not in the set Or \ Escape Special Character {} Tag expression : C/C++ identifier :q Quoted string :z Integer :b Space or tab 3-5

40 Defining a Network Device Module Target Chapter 3 Managing Terminal Targets Defining a Network Device Module Target Some Cisco network devices are chassis systems that can hold other network devices such as ACE, FWSM, on boards that plug into the chassis. Use the Network Device Module to create a network device module target which can be used as a dependent of a terminal target as well as an independent network device target that can be used by network processes for execution. Step 1 On the Definitions Targets view, right-click, and choose New > Network Device Module. The New Network Device Module Wizard displays. Figure 3-2 New Network Device Module Wizard General Information Panel Step 2 On the General panel, enter the appropriate general information: Field Display name Name of the target Brief description of the target Step 3 Click Next to continue. 3-6

41 Chapter 3 Managing Terminal Targets Defining a Network Device Module Target The Terminal Connection panel displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 3-3 New Network Device Module Wizard Terminal Connection Panel Step 4 On the Terminal Connection panel, enter the appropriate target information to specify the connection information to the appropriate server. Field Chassis system Switch number Slot number Process Id Command to access From the drop-down list, select the appropriate terminal target on which the network module resides. To view the properties for the selected target, click the Properties tool. To create a new terminal target, click New > Terminal to create a new terminal target. Check the check box and in the text field, enter the appropriate switch number for the chassis system. Enter the slot number on which the network device module resides. Enter the processor Id on which the network device module resides. Enter the session command to access the network device module. The default command is session slot [Slot Number] processor [Processor Id]. 3-7

42 Defining a Network Device Module Target Chapter 3 Managing Terminal Targets Field Prompt prefix Default runtime user Enter the command prompt prefix that will be used by the device type configurations and expects when issuing commands and connecting to the device. Adding a regex character, such as $, >, and #, at the end of a prompt in the Prompt Prefix field invalidates the command prompt prefix. Regular expressions should be placed in the appropriate Terminal Interaction Pattern fields. See Step 8 to configure the interaction patterns on the Connection Patterns panel. Example: If you connect to the terminal, and the prompt is Cisco_7606#, enter the regular expression that will match the entire prefix (before #) using any of the following expressions: CISCO.*.*7606 CISCO_7606 Select the default runtime user account that contains the credentials to connect to the target. Note To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user account, click New > Runtime User to create a new Runtime User account. For additional information, see Chapter 2, Managing Terminal Runtime Users. Step 5 Click Next to continue. 3-8

43 Chapter 3 Managing Terminal Targets Defining a Network Device Module Target The Terminal Interaction Patterns panel displays. The user may specify terminal interaction patterns on this panel. If user does not choose to customize patterns from a selected expect template, the user will be taken to the Completion panel directly after the target is verified. If user chooses to customize patterns, the next panel will be Connection Patterns panel. Figure 3-4 New Network Device Module Wizard Terminal Interaction Patterns Panel Note Click the Reference tool to select a defined variable or reference an object within the process from the Insert Variable Reference dialog box. For additional information, see Inserting a Target Variable Reference, page Step 6 On the Terminal Interaction Patterns panel, configure the terminal interaction patterns for the target. Field Use patterns common for the following device Select this radio button to choose one of the pre-defined expect templates from the drop-down list. Cisco IOS Device Select this option to use the default pattern values used by the device. Unix/Linux Systems Select this option to use the default pattern values indicated for a Unix device during the completion of a session command. To view the properties for the selected expect template, click the Properties tool. To create a new expect template, click New > Expect Template to create a new expect template. See Configuring an Expect Template, page

44 Defining a Network Device Module Target Chapter 3 Managing Terminal Targets Field Customize patterns for this connection Check this check box to customize the default values for the selected expect template. Note If this check box is unchecked, then clicking Next will navigate to the Completion panel. Step 7 Click Next to continue. The Connection Patterns panel displays if the Customize patterns for this connection check box is checked. Figure 3-5 New Network Device Module Wizard Connection Patterns Panel Note Click the Reference tool to select a defined variable or reference an object within the process from the Insert Variable Reference dialog box. For additional information, see Inserting a Target Variable Reference, page Step 8 On the Connection Patterns panel, configure the terminal interaction patterns for the target. Field Prompt pattern Error pattern Admin prompt pattern Enter the system prompt pattern in regular expression. Enter the error message pattern in regular expression. Enter the admin prompt pattern in regular expression. Note Click the Expression arrow to the right of the Reference icon to add a regular expression the field. For additional information on regular expressions, see Common Regular Expressions, page

45 Chapter 3 Managing Terminal Targets Defining a Network Device Module Target Step 9 Click Next to continue. The Login Expects panel displays. Figure 3-6 New Network Device Module Wizard Login Expects Panel Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 10 To modify the list of login expects which sequence of login expects for the target connection, click the following buttons, as necessary. Button Add Edit Remove Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. Note See Adding an Expect Parameter, page Highlight the appropriate item and click Remove to remove the item from the list. Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. Note Removing an Expect Parameter, page

46 Defining a Network Device Module Target Chapter 3 Managing Terminal Targets Button Move Up Move Down Highlight the appropriate item and then click this button to move the item up list. Highlight the appropriate item and then click this button to move the item down list. Step 11 To elevate the privilege command for login expects: Field Elevating Privilege command Elevating Privilege expects Check this check box and in the text field, enter the command or select the reference variable containing the command to elevate the privilege for the expect. Use this section to view and/or define the login expect sequence for the elevating privilege command expects. To modify the list of expects, see See Adding an Expect Parameter, page 3-32or Removing an Expect Parameter, page The defined login expects display in the table. Column Name Regular Expression Operation Type User response Name of the case defining what to expect Matches the characters in terminal output Displays what operation takes place if an expected regular expression match is encountered in the terminal output User Response Provides input to the terminal and continue execution of the activity Runtime User's Username Allows user to respond with the username of the runtime user for the session Runtime User's Password Allows user to respond with the password of the runtime user for the session Runtime User's Admin Password Allows user to respond with the admin password of the runtime user. If the runtime user doesn t have the admin password, the regular password will be used. Succeeded Complete activity and set its status to Completed Failed (Completed) Complete activity and set its status to Failed (Completed) Failed (Not Completed) Complete activity and set its status to Failed (Not Completed) Displays the defined user input string text Step 12 Click Next to continue. 3-12

47 Chapter 3 Managing Terminal Targets Defining a Terminal Target Step 13 The Completing the New [Network Device Module] Wizard panel displays the connection information about the device target added to TEO. Verify the information on the panel and click Finish to close the wizard. The new target is displayed on the Definitions Targets view. Defining a Terminal Target Use the Terminal target to specify the connection information used to access the device used for processes to run against. The connection information includes IP address or host name, protocol type, port and the runtime user credentials to access the device. Step 1 On the Definitions workspace, right-click Targets, and choose New > Terminal. The New Terminal Wizard displays. Figure 3-7 New Terminal Wizard General Information Panel Step 2 On the General panel, enter the appropriate general information: Field Display name Name of the target Brief description of the target Step 3 Click Next to continue. 3-13

48 Defining a Terminal Target Chapter 3 Managing Terminal Targets The Terminal Connection panel displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 3-8 New Terminal Wizard Terminal Connection Panel Step 4 On the Terminal Connection panel, enter the appropriate target information to specify the connection information to the appropriate server. Field Protocol Host name Port Select the appropriate protocol from the drop-down list. SSH Telnet Host name or IP address of the network device Port number used to access the appropriate terminal target port (Default: SSH server: 22, Telnet server: 23) 3-14

49 Chapter 3 Managing Terminal Targets Defining a Terminal Target Field Prompt prefix Default runtime user Use patterns common for the following device Customize patterns for this connection Enter the command prompt prefix that will be used by the device type configurations and expects when issuing commands and connecting to the device. Adding a regex character, such as $, >, and #, at the end of a prompt in the Prompt Prefix field invalidates the command prompt prefix. Regular expressions should be placed in the appropriate Terminal Interaction Pattern fields. See Step 6 to configure the interaction patterns on the Connection Patterns panel. Example: If you connect to the terminal, and the prompt is Cisco_7606#, enter the regular expression that will match the entire prefix (before #) using any of the following expressions: CISCO.*.*7606 CISCO_7606 Select the default runtime user account that contains the credentials to connect to the target. Note To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user account, click New > Runtime User to create a new Runtime User account. For additional information, see Chapter 2, Managing Terminal Runtime Users. Select this radio button to choose one of the pre-defined expect templates from the drop-down list. Cisco IOS Device Select this option to use the default pattern values used by the device. Unix/Linux Systems Select this option to use the default pattern values indicated for a Unix device during the completion of a session command. To view the properties for the selected expect template, click the Properties tool. To create a new terminal target, click New > Expect Template to create a new expect template. See Configuring an Expect Template, page 1-8. Check this check box to customize the default values for the selected expect template. If this check box is unchecked, then clicking Next will navigate to the Host-Based Authentication panel. Step 5 Click Next to continue. 3-15

50 Defining a Terminal Target Chapter 3 Managing Terminal Targets The Connection Patterns panel displays if the Customize patterns for this connection check box is checked. Note If the Customize patterns for this connection check box is unchecked, skip to Step 11 for Host-Based Authentication instructions. Figure 3-9 New Terminal Wizard Connection Patterns Panel Note Click the Reference tool to select a defined variable or reference an object within the process from the Insert Variable Reference dialog box. For additional information, see Inserting a Target Variable Reference, page Step 6 On the Connection Patterns panel, configure the terminal interaction patterns for the target. Field Prompt pattern Error pattern Admin prompt pattern Enter the system prompt pattern in regular expression. Enter the error message pattern in regular expression. Enter the admin prompt pattern in regular expression. Note Click the Expression arrow to the right of the Reference icon to add a regular expression the field. For additional information on regular expressions, see Common Regular Expressions, page 3-5. Step 7 Click Next to continue. 3-16

51 Chapter 3 Managing Terminal Targets Defining a Terminal Target The Login Expects panel displays. Figure 3-10 New Terminal Wizard Login Expects Panel Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 8 To modify the list of login expects which sequence of login expects for the target connection, click the following buttons, as necessary. Button Add Edit Remove Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. Note See Adding an Expect Parameter, page Highlight the appropriate item and click Remove to remove the item from the list. Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. Note Removing an Expect Parameter, page

52 Defining a Terminal Target Chapter 3 Managing Terminal Targets Button Move Up Move Down Highlight the appropriate item and then click this button to move the item up list. Highlight the appropriate item and then click this button to move the item down list. Step 9 To elevate the privilege command for login expects: Field Elevating Privilege command Elevating Privilege expects Check this check box and in the text field, enter the command or select the reference variable containing the command to elevate the privilege for the expect. Use this section to view and/or define the login expect sequence for the elevating privilege command expects. To modify the list of expects, see See Adding an Expect Parameter, page 3-32or Removing an Expect Parameter, page The defined login expects display in the table. Column Name Regular Expression Operation Type User response Name of the case defining what to expect Matches the characters in terminal output Displays what operation takes place if an expected regular expression match is encountered in the terminal output User Response Provides input to the terminal and continue execution of the activity Runtime User's Username Allows user to respond with the username of the runtime user for the session Runtime User's Password Allows user to respond with the password of the runtime user for the session Runtime User's Admin Password Allows user to respond with the admin password of the runtime user. If the runtime user doesn t have the admin password, the regular password will be used. Succeeded Complete activity and set its status to Completed Failed (Completed) Complete activity and set its status to Failed (Completed) Failed (Not Completed) Complete activity and set its status to Failed (Not Completed) Displays the defined user input string text Step 10 Click Next to continue. 3-18

53 Chapter 3 Managing Terminal Targets Defining a Terminal Target The Host-Based Authentication panel displays. Users can define default host public and private keys on the Terminal Adapter settings. This panel allows users to select a specific private key for the target. The private key will be used for host-based authentication if a target does not specify its own keys. Figure 3-11 New Terminal Wizard Host-Based Authentication Panel Step 11 On the Host-Based Authentication panel, specify whether the target should allow authentication based on the host system of the user and the user name on the remote host system. Field Use host-based authentication Use the default host keys Private key Check this check box to indicate that host-based authentication will be used with this target. If this check box is unchecked, then host-based authentication will not be used. This check box becomes enabled after the Use host-based authentication check box is checked. Check this check box to indicate the host keys defined on the Terminal Adapter property page will be used for this target. If this check box is unchecked, then the user will need to load the appropriate private key to be used to validate this target. This box becomes enabled only if the Use the default host keys check box is unchecked. To the right of the display-only field, click Browse to launch the Load Private Key dialog box to select a private key. See Selecting a Private Key, page

54 Defining a Terminal Target Chapter 3 Managing Terminal Targets Step 12 Click Next to continue. The Network Modules panel displays. Figure 3-12 New Terminal Wizard Network Modules Panel Step 13 On the Network Modules panel, review the list of network modules assigned to the terminal target.these network device modules are considered dependents of the terminal target. Column Display name Enabled Switch number Slot number Process Id Name of the network device Indicates whether the network device module is enabled (True) or disabled (False). A disabled network device module is unavailable for execution. Switch number for the chassis system Slot number on which the network device module resides Processor Id on which the network device module resides Step 14 If the appropriate network device module is not displayed, users can create a network device module target from within this wizard to be used as a dependent of the terminal target. To modify the list of network module devices, use the following buttons: Button New Click New to launch the Network Device Module wizard to configure a new network device. See Defining a Network Device Module Target, page

55 Chapter 3 Managing Terminal Targets Defining a Terminal Target Button Properties Remove Highlight the appropriate network module, and click this button to view or modify the properties of the network device. Highlight the appropriate network module, and click this button to remove the network device module from the terminal target. Removing this network device from the terminal target permanently deletes the network device module from TEO. Step 15 Step 16 Click Next to continue. After the target is created, the Completing the New Terminal Wizard panel displays the connection information about the device target added to TEO. Verify the information on the panel and click Finish to close the wizard. The new target is displayed on the Definitions Targets view. 3-21

56 Defining a Unix/Linux System Target Chapter 3 Managing Terminal Targets Defining a Unix/Linux System Target Use the Unix/Linux System target to specify the connection information for the SSH server used for processes to run against. The Unix/Linux System target supports session based activities. Step 1 On the Definitions Targets view, right-click, and choose New > Unix/Linux System. The New Unix/Linux System Properties dialog box displays. Figure 3-13 New Unix/Linux System Properties Dialog Box General Tab Step 2 On the General tab, enter the appropriate general information: Field Display name Type Owner Name of the target Display-only. Type of target User name of the owner of the target. This is typically the person who created the target. Click Browse to launch the Select User or Group dialog box to change the owner. 3-22

57 Chapter 3 Managing Terminal Targets Defining a Unix/Linux System Target Field Status Status Information Organization Enabled Status of the target Unknown Status of the target unknown Normal No known problems with this target Unreachable TEO is experiencing problems connecting to the target and executing activities Disabled Target is disabled and is not available for activity execution Detailed information regarding the target status and the reasons for target being unreachable Name of the company which supports the target Brief description of the target Check or uncheck the check box to enable or disable the target. The check box is selected by default which makes it available immediately upon creation. If you uncheck the check box, the target is disabled and will be unavailable for execution. Step 3 Click the Connection tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 3-14 New Unix/Linux System Properties Dialog Box Connection Tab 3-23

58 Defining a Unix/Linux System Target Chapter 3 Managing Terminal Targets Step 4 On the Connection tab, enter the appropriate target information to specify the connection information to the appropriate SSH server. Field Host name Port Prompt prefix Default runtime user Enable code injection prevention Maximum allowed concurrent sessions Host name or IP address of selected server Port number used to access used to access the selected protocol Enter the command prompt prefix that will be used by the device type configurations and expects when issuing commands and connecting to the device. Adding a regex character, such as $, >, and #, at the end of a prompt in the Prompt Prefix field invalidates the command prompt prefix. Regular expressions should be placed in the appropriate Terminal Interaction Pattern fields. See Step 9 to customize the interaction patterns on the Advanced tab. Example: Unix system prompt prefix is defined by the user default login script. it usually contains username, node name or current directory name. If the user does not define anything, the prompt prefix is empty. If you connect to the terminal, and the prompt is jsmith@tbd-sh03-it ~$, enter the regular expression that will match the entire prefix (before #) using any of the following expressions:.*tbd-sh03-it.* \[\w+@tbd-sh03-it.*\] Select the default runtime user account that contains the credentials to connect to the target. Note To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user account, click New > Runtime User to create a new Runtime User account. For additional information, see Chapter 2, Managing Terminal Runtime Users. Check this check box to enable the protection which prevents code that is injected to exploit the security vulnerability. Enter the maximum allowed open sessions to run concurrently. (Default: 3) If the user tries to open new session via Open Session activity, it will wait in a queue until there is a session available to open. 3-24

59 Chapter 3 Managing Terminal Targets Defining a Unix/Linux System Target Step 5 Click the Authentication tab to indicate whether the target should allow authentication based on the host system. Users can define default host public and private keys on the Terminal Adapter settings. This tab allows users to select a specific private key for the target. The private key will be used for host-based authentication if a target does not specify its own keys. Figure 3-15 New Unix/Linux System Properties Dialog Box Authentication Tab Step 6 On the Authentication tab, specify the user and the user name on the remote host system. Field Use host-based authentication Use the default host keys Private key Check this check box to indicate that host-based authentication will be used with this target. If this check box is unchecked, then host-based authentication will not be used. This check box becomes enabled after the Use host-based authentication check box is checked. Check this check box to indicate the host keys defined on the Terminal Adapter property page will be used for this target. If this check box is unchecked, then the user will need to load the appropriate private key to be used to validate this target. This box becomes enabled only if the Use the default host keys check box is unchecked. To the right of the display-only field, click Browse to launch the Load Private Key dialog box to select a private key. See Selecting a Private Key, page

60 Defining a Unix/Linux System Target Chapter 3 Managing Terminal Targets Step 7 Click the Advanced tab to continue. Figure 3-16 New Unix/Linux System Properties Dialog Box Advanced Tab 3-26

61 Chapter 3 Managing Terminal Targets Defining a Unix/Linux System Target Step 8 On the Advanced tab, configure the interaction patterns for the target. Field Use patterns common for the following device Customize patterns for this target Select this radio button to choose one of the pre-defined device targets from the drop-down list. Cisco IOS Device Select this option to use the default pattern values used by the device during the completion of a session command. Unix Select this option to use the default pattern values indicated for a Unix device during the completion of a session command To view the properties for the selected expect template, click the Properties tool. To create a new terminal target, click New > Expect Template to create a new expect template. See Configuring an Expect Template, page 1-8. Select this radio button to enable the display-only sections in order to customize the default values for the selected device type. Step 9 To customize the interaction patterns, complete the following fields, as necessary. Note Click the Reference tool to select a defined variable or reference an object within the process from the Insert Variable Reference dialog box. For additional information, see Inserting a Target Variable Reference, page Field Prompt Error Admin prompt Enter the system prompt pattern in regular expression. Enter the error message pattern in regular expression. Enter the admin prompt pattern in regular expression. Note Click the Expression arrow to the right of the Reference icon to add a regular expression the field. For additional information on regular expressions, see Common Regular Expressions, page 3-5. Step 10 To modify the list of login expects, click the following buttons, as necessary. Button Add Edit Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. Note See Adding an Expect Parameter, page Highlight the appropriate item and click Remove to remove the item from the list. 3-27

62 Defining a Unix/Linux System Target Chapter 3 Managing Terminal Targets Button Remove Move Up Move Down Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. Note Removing an Expect Parameter, page Highlight the appropriate item and then click this button to move the item up list. Highlight the appropriate item and then click this button to move the item down list. Step 11 To elevate the privilege command for login expects: Field Elevating Privilege command Elevating Privilege expects Check this check box and in the text field, enter the command or select the reference variable containing the command to elevate the privilege for the expect. Use this section to view and/or define the login expect sequence for the elevating privilege command expects. To modify the list of expects, see See Adding an Expect Parameter, page 3-32or Removing an Expect Parameter, page The defined login expects display in the table. Column Name Regular Expression Name of the case defining what to expect Matches the characters in terminal output 3-28

63 Chapter 3 Managing Terminal Targets Defining a Unix/Linux System Target Column Operation Type User response Displays what operation takes place if an expected regular expression match is encountered in the terminal output User Response Provides input to the terminal and continue execution of the activity Runtime User's Username Allows user to respond with the username of the runtime user for the session Runtime User's Password Allows user to respond with the password of the runtime user for the session Runtime User's Admin Password Allows user to respond with the admin password of the runtime user. If the runtime user doesn t have the admin password, the regular password will be used. Succeeded Complete activity and set its status to Completed Failed (Completed) Complete activity and set its status to Failed (Completed) Failed (Not Completed) Complete activity and set its status to Failed (Not Completed) Displays the defined user input string text Step 12 Review the information on the following tabs, as necessary, and then click OK to close the dialog box. Open Sessions Displays the information about sessions currently opened on the target and sessions waiting to be opened. See Viewing Target Open Sessions, page Member Of Displays the target groups to which the target belongs. This tab will remain blank until added to a target group. See Viewing Member Of Properties, page Extended Properties Displays the list of all target properties defined for this target type. This tab will remain blank until an extended target property is defined for the target type. See Viewing Extended Properties, page Used By Displays the objects which reference the target. This tab will remain blank until the target is used by an object. See Viewing Used By Properties, page History Displays the history of actions taken against the target. This tab remains blank until after the initial target creation. See Viewing Targets History, page The new target displays in the list of targets on the Definitions Targets view. 3-29

64 Managing Target Definitions Chapter 3 Managing Terminal Targets Managing Target Definitions Use the Definitions Targets view to modify and review target information. This view can be used to perform the following functions: Enable/Disable targets Modify target properties Review the objects in the product that use the target Review a history of changes made to the target Delete the target Enabling a Target A target is enabled by default. If a target is manually disabled, the target must be enabled before it is available for execution. To enable a target: On the Definitions Target view, highlight the target, and then use one of the following methods: tool to Disabling a Target Disabling a target prevents the item from being available for execution. The disabled target is not removed from the list of targets in the Definitions Target Results pane. To disable a target: On the Definitions Target view, highlight the target, and then use one of the following methods: On the Results pane, right-click and select Enable. -or- On the Details pane, select the Click here to enable option. The Enabled column on the Results pane changes to True. If necessary, click the Refresh update the view. On the Results pane, right-click and select Disable. -or- On the Details pane, select the Click here to disable option. The Enabled column on the Results pane changes to False. If necessary, click the Refresh tool to update the view. 3-30

65 Chapter 3 Managing Terminal Targets Managing Target Definitions Modifying Targets Use the Definitions Targets view to modify the configured targets. After the initial creation, not all fields are available for updating. To modify a target: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Modify the information on the target property tabs, as necessary. Tab General Connection Authentication Advanced Network Modules Modify the general information about the target Configure the connection properties for the defined target Specify the host-based authentication of the system of the user and the user name on the remote host system Customize the settings for the interaction patterns Modify the list of network modules assigned to the terminal target Step 3 Click OK to save the changes and close the dialog box. Configuring Total Concurrent Sessions on a Target Users can specify the limits on how many concurrent sessions can be run against a target. When the total live sessions reach limits, the activity that needs to open a new session will wait until a live session is closed. The waiting Open Terminal Session activities will be display in the target s Open Sessions property page. The Network Device Module inherits the max allowed sessions from its chassis system by default. Users cannot adjust the value on the network device module more than value set by the chassis system. Therefore users can only modify the amount concurrent sessions against the network device module through its chassis system. Due to the nature of network device management, TEO may have a very large number of TEO Terminal Adapter targets and concurrent running TEO processes. Users can specify the total sessions allowed against the Terminal Adapter in the configuration file to minimize the negative impact on performance and resource usage. 3-31

66 Managing Target Definitions Chapter 3 Managing Terminal Targets To configure the maximum sessions against a target: Step 1 Step 2 Step 3 Step 4 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Connection tab to modify the maximum allowed sessions. In the Maximum allowed concurrent session field, enter the maximum allowed open sessions to run concurrently. (Default: Terminal target: 3, Unix/Linux target: 1) Click OK to close the dialog box. Adding an Expect Parameter Use the Expect dialog box to configure the expect parameters to manage the Terminal target command output. The Add button on the device activities and targets launch the Expect dialog box for users to configure the expect parameters to be added to the list of expects and matched in the output. To add a expect parameter: Step 1 On the Execute Terminal property page, click Add. The Expect dialog box displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 3-17 Expect Dialog Box 3-32

67 Chapter 3 Managing Terminal Targets Managing Target Definitions Step 2 Complete the following fields, as necessary. Field Name Regular Expression Match Case Operation Type User Response Hidden Name of the case defining what to expect Matches the characters in terminal output Note The Expression arrow displayed to the right of the Reference icon indicates that a regular expression is available. For additional information on regular expressions, see Common Regular Expressions, page 3-5. Indicates whether the regular expression is case-sensitive Displays what operation takes place if an expected regular expression match is encountered in the terminal output User Response Provides input to the terminal and continue execution of the activity Runtime User's Username Allows user to respond with the username of the runtime user for the session Runtime User's Password Allows user to respond with the password of the runtime user for the session Runtime User's Admin Password Allows user to respond with the admin password of the runtime user. If the runtime user doesn t have the admin password, the regular password will be used. Succeeded Complete activity and set its status to Completed Failed (Completed) Complete activity and set its status to Failed (Completed) Failed (Not Completed) Complete activity and set its status to Failed (Not Completed) Field is enabled when User Response is selected from the Operation Type drop-down list. This field can also remain empty. When User Response is selected, enter the appropriate string text for the user. This check box is enabled when User Response is selected from the Operation Type drop-down list. Check this check box and enter the string text into the Operation Parameter field, which will be used as security-sensitive content for the expect. Step 3 Click OK. The expect parameters is added to the list of login expects. 3-33

68 Managing Target Definitions Chapter 3 Managing Terminal Targets Removing an Expect Parameter Use the following steps to remove a configured expect parameter To remove a parameter, highlight the appropriate item, and then click Remove. The selected parameter is removed from the list of expect parameters on the tab. Modifying Target Interaction Pattern Properties Use the followings steps to modify interaction patterns for Terminal adapter targets. The following steps uses a Terminal target as an example. To modify the target interaction patterns: Step 1 Step 2 Step 3 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Advanced tab to modify the interaction pattern properties. Select the Use patterns common for the following device radio button and then choose one of the pre-defined device targets from the drop-down list. Option Cisco IOS Device Unix/Linux System Select this option to use the default pattern values used by the device during the completion of a session command. Select this option to use the default pattern values indicated for a Unix/Linux device during the completion of a session command. Step 4 Step 5 To customize the terminal interaction patterns for the target, select the Customize patterns for this target radio button to enable the display-only sections in order to customize the default values for the selected device type. Under Terminal Interaction Patterns, modify the prompt prefixes for the target. Note Click the Reference tool to the right to select a defined variable or reference an object within the process from the Insert Variable Reference dialog box. For additional information, see Inserting a Target Variable Reference, page Field Prompt Error Admin prompt Enter the system prompt pattern in regular expression. Enter the error message pattern in regular expression. Enter the admin prompt pattern in regular expression. Note Click the Expression arrow to the right of the Reference icon to add a regular expression the field. For additional information on regular expressions, see Common Regular Expressions, page

69 Chapter 3 Managing Terminal Targets Managing Target Definitions Step 6 To modify the list of login expects, click the following buttons, as necessary. Button Add Edit Remove Move Up Move Down Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. Note See Adding an Expect Parameter, page Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. Highlight the appropriate item and click Remove to remove the item from the list. Note Removing an Expect Parameter, page Highlight the appropriate item and then click this button to move the item up list. Highlight the appropriate item and then click this button to move the item down list. Step 7 To elevate the privilege command for login expects: Field Elevating Privilege command Elevating Privilege expects Check this check box and in the text field, enter the command or select the reference variable containing the command to elevate the privilege for the expect. Use this section to view and/or define the login expect sequence for the elevating privilege command expects. To modify the list of expects, see See Adding an Expect Parameter, page 3-32or Removing an Expect Parameter, page Step 8 Click OK to close the dialog box. 3-35

70 Managing Target Definitions Chapter 3 Managing Terminal Targets Defining Target Criteria Use the Target Selection Criteria dialog box to specify the matching criteria for the selected target group. To define the target selection criteria: Step 1 On the Target tab, select the Execute on this target group radio button, and then select the appropriate target group from the drop-down list. Figure 3-18 Target Tab Execute on this target group Section Step 2 Step 3 From the Choose a target using this algorithm drop-down list, select Choose the target that satisfies the specified criteria. On the Criteria box, click Browse. The Target Selection Criteria dialog box displays. Figure 3-19 Target Selection Criteria Dialog Box 3-36

71 Chapter 3 Managing Terminal Targets Managing Target Definitions Step 4 On the Properties pane, specify the following information, as necessary: Field Property Operators Value Choose the appropriate property to match within the target. Click the Reference tool to select the variable from the Insert Variable Reference dialog box. See Inserting a Target Variable Reference, page Select the appropriate operator to be used to evaluate the expression. The displayed operators depend on the selected property. Note For information on the displayed operators, see Comparison Operators, page Enter the appropriate value for the target Step 5 To modify the list of Properties pane containing target criteria, click one of the following buttons: Button Add Remove Click this button to a new Properties pane to complete with criteria for the target. Click this button to remove the selected last Properties pane in the display Step 6 Click OK to return to the Target tab. The defined criteria displays in the display-only box. Comparison Operators The following table contains operators that may display throughout TEO. Operator contains contains (case-sensitive) contains only contains only (case-sensitive) does not match wildcard Iterates through the contents of the collection and determines if the specified item exists (if this is a string collection, this is case-insensitive) Iterates through the contents of the collection and determines if the specified item exists (same as above, but a case-insensitive version) Iterates through the contents of the collection and determines if the only item in the collection is the specified item (if this is a string collection, this is case-insensitive) Iterates through the contents of the collection and determines if the only item in the collection is the specified item (same as above, but a case-insensitive version) Determines if the item does not match all items in the wildcard example 3-37

72 Managing Target Definitions Chapter 3 Managing Terminal Targets Operator is empty equals not equals matches regular expression matches wildcard equals (case-sensitive) less than [<] more than [>] equal [=] not equal [>] greater than or equal [>=] less than or equal [<=] Determines if there are items in the collection or not Determines if the left side equals the right side (if this is a string comparison, this is case-insensitive) Determines if the left side does not equal the right side Determines if the left side matches the regular expression specified on the right side Determines if the left side matches the wildcard specified on the right side Determines if the left side equals the right (this is the case-sensitive version of Equals for string) Determines if a value is less than another value Determines if a value is greater than another value Determines if a value is equal to another value Determines if a value is not equal to another value Determines if a value is greater than or equal to another value Determines if a value is less than or equal to another value Inserting a Target Variable Reference The Reference icon to the right of a text field indicates that the field can be populated by referencing a defined variable or the property of another activity or process. Use the Insert Variable Reference dialog box to select a defined variable or reference an object to populate a field. The OK button does not activate until a valid property or variable is selected. On either available terminal target, the user can customize the patterns for the device. On the prompt pattern fields, the user can enter the appropriate patterns or select from a list of target reference variables. To insert a target variable reference: Step 1 Step 2 To the right of a field on a property page, click the Reference tool. The Insert Variable Reference dialog box displays. Check the Show Advanced check box to display all items that are available for referencing. If the check box is not checked, then only the most commonly-used items are displayed for activities, processes or events. 3-38

73 Chapter 3 Managing Terminal Targets Managing Target Definitions Figure 3-20 Insert Variable Reference Dialog Box Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 3 Step 4 Click the Target Expand (+) to display the reference objects for the target. From the list of displayed objects, select the appropriate property. Reference Variable Admin Prompt Pattern Created by DNS Name Error Pattern Host Name IP Address Is Normal Status Is Unreachable Status Admin prompt pattern in regular expression User name or the owner of the target of the target DNS host name of the network device (based on DNS host entry lookup of connection information) Error message pattern in regular expression Name/IP address that the user specified for the target during its creation IP address of the network device (based on DNS host entry lookup of connection information) Status is normal and indicates that there are no known problems with this target Status is unreachable which indicates that no known problems with this target 3-39

74 Managing Target Definitions Chapter 3 Managing Terminal Targets Reference Variable Modified by Name Node Name OS Name OS Version Port Prompt Pattern Prompt Prefix Protocol SCP Enabled SFTP Enabled Status Information Type User name of the individual who modified the target Display name of the target Node name of the target Name of the operating system on the target Version of the operating system on the target Port number used to access used to access the selected protocol System prompt pattern in regular expression Command prompt prefix that will be used by the device type configurations and expects when issuing commands and connecting to the device SSH or Telnet (as a string) Indicates whether the target has SCP protocol enabled for file transfer Indicates whether the target has SFTP protocol enabled for file transfer Detailed information regarding the target status and the reasons for target being unreachable Type of target Step 5 Click OK to add the related text field populates with the selected value. Deleting a Target Use the Definitions Target view to delete targets that are no longer used. Before deleting a target, access the properties, and click the Used By tab to view where objects are being referenced by the target. This ensures that deleting the target does not affect any processes or activities. If there are any entries in the Used By tab, the deletion will fail. To delete a target: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Delete. The Confirm Delete dialog box displays. Click Yes to delete the target. 3-40

75 Chapter 3 Managing Terminal Targets Managing Target Definitions Viewing Network Module Device Targets Use the Network Device Module tab to view the list of network modules assigned to the target. These network device modules are considered dependents of the chassis system. Therefore, network device modules can only be removed from within the chassis system. If the appropriate network device module is not displayed, users can create a network device module target from within this wizard to be used as a dependent of the chassis system. To view target network modules: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Network Modules tab to review the list of network device modules dependant on the target. Column Display name Enabled Switch number Slot number Process Id Name of the network device Indicates whether the network device module is enabled (True) or disabled (False). A disabled network device module is unavailable for execution. Switch number for the chassis system Slot number on which the network device module resides Processor Id on which the network device module resides Note Step 3 To create a new network device modules, click New. For additional information, see Defining a Network Device Module Target, page 3-6. Click OK to close the dialog box. Viewing Target Open Sessions Use the Open Sessions tab to review the information about sessions currently opened on the target and sessions waiting to be opened. Note To configure the amount of total open sessions, see Configuring Total Concurrent Sessions on a Target, page To view the target open sessions: Step 1 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. 3-41

76 Managing Target Definitions Chapter 3 Managing Terminal Targets Step 2 Click the Open Sessions tab to review the information about sessions currently opened on the target and sessions waiting to be opened. Column Process Name Process Executor Process Start Time Activity Name Activity Start Time Name of the process that opened the session Target against which the process is executing Time when the process was started Name of the Open Terminal Session activity that opened the session Time when Open Terminal Session activity started running Step 3 Step 4 To refresh the list of open sessions, click Refresh. Click OK to close the dialog box. Viewing Member Of Properties Use the Member of tab to view the target groups to which a target belongs. The name and type of target group displays in the list box. To view the target groups: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Member Of tab to view the target groups. Field Display name Type Name of the target group Display-only. Type of target group Brief description of the target Step 3 Step 4 To view the properties for a specific object, highlight the object, right-click and choose Properties. Click OK to close the dialog box. 3-42

77 Chapter 3 Managing Terminal Targets Managing Target Definitions Viewing Extended Properties Use the Extended Properties tab to view the list of all extended target properties defined for a specific target type. This tab will remain blank until an extended target property is defined for the target type. For additional information on extended properties, refer to the Tidal Enterprise Orchestrator Reference Guide. To view the target extended properties: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Extended Properties tab to view the extended properties defined for the target. Column Name Value Using Default Name of the target property Displays value for the target property. If no value is defined, then the default property value will display. Indicates whether the default property value is displayed. Yes will display if no value is defined. No will display if a value is defined for the target property. Step 3 Click OK to close the dialog box. Modifying Extended Property Values To modify the extended properties: On the Extended Properties tab, highlight the appropriate target property and click the appropriate button to define or modify the value. Button Edit Reset Value Click this button to defined or modify the value of a specific target property. The Edit button is disabled by default. The button will be enabled only when a target property is selected in the list. Click this button to reset the value of the target property to its default value. The Reset Value is enabled only if a value is specified for a selected target property. 3-43

78 Managing Target Definitions Chapter 3 Managing Terminal Targets Viewing Used By Properties Use the Used By tab to display the objects that directly reference the selected target in their configuration. Because the Used By tab displays objects in a tree view, users can also display the objects which directly reference the top level objects for the selected object. The objects at the top level are the objects that reference the selected object directly, but users can expand the listed objects and see their referenced objects. Example: If object A is used by objects X and Y and object X is used by object Q, then on the property pages of object A, the user will see X and Y listed. If a user expands (+) object X, then object Q will display. To view used by objects: Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the Used By tab to view the objects used by the target. Object Display name Type Name of the object Type of object Step 3 Step 4 To view the properties for a specific object, highlight the object, right-click and choose Properties. Click OK to close the dialog box. Viewing Targets History Use the History tab to view a history of changes that have been made to the target. Step 1 Step 2 On the Definitions Targets view, highlight the appropriate target, right-click and choose Properties. The [Target] Properties dialog box displays. Click the History tab to view the changes made to the target. Column Created by Created time Time Change Type User The user name of the person who created the object The date and time the object was created The date and time the action occurred The action that occurred The user name of the person that performed the action Information about the action that was performed 3-44

79 Chapter 3 Managing Terminal Targets Managing Target Definitions Step 3 Step 4 To view the details for a specific action, highlight the appropriate time, right-click and choose Properties. Click OK to close the dialog box. 3-45

80 Managing Target Definitions Chapter 3 Managing Terminal Targets 3-46

81 CHAPTER 2 Managing Terminal Runtime Users Many operating system and application activities require credentials for proper execution. The Runtime Users feature is used to create a runtime user record to store the information about the user security context and to pass this information to the adapters for activity execution, event monitoring and some target operations (such as availability monitoring and discovery). When defining a process or certain activities, you can use the runtime user records that are defined in the product to assign credentials for the process or activity. This chapter provides instructions for viewing and defining runtime user accounts: Accessing Definitions Runtime users, page 2-2 Defining a Public-key Authenticated Admin Runtime User Account, page 2-4 Defining a Runtime Admin User, page 2-6 Defining a Runtime User Account, page 2-8 Managing Runtime User Definitions, page

82 Accessing Definitions Runtime users Chapter 2 Managing Terminal Runtime Users Accessing Definitions Runtime users Use the Definitions Runtime Users view to display the credentials of the runtime users and to specify new runtime user credentials, update the credentials of users, or delete users. To access the Runtime Users properties: On the Definitions workspace, select Runtime Users. The Results pane displays. Figure 2-1 Definitions Runtime Users Information about the runtime user accounts can be displayed in the following columns: Column Display name Type User name Owner Last Modified Time Last Modified By Id The display name assigned to the runtime user account The type of user account The user name assigned to the account The user name of the person who created the account The time the credentials were last modified The user name of the person who last modified the credentials The unique identification number of the runtime user definition A brief overview of the runtime user definition 2-2

83 Chapter 2 Managing Terminal Runtime Users Accessing Definitions Runtime users Column Type Created Time Created By Automation Pack Customizable A brief description of the information in the Type column time the runtime user account was created The user name of the person who created the runtime user definition Name of the automation pack from which the runtime user record was imported Indicates the customization setting for the object in the automation pack Runtime User Details Pane The Details pane in the lower portion of the page displays detailed information about the selected runtime user. Clicking a link on a tab page opens the Properties dialog box for the runtime user. Tab General Attributes Displays general information about the item including the name, type, value, a brief description of the runtime user Displays the dates, times and process owner associated with the creation and modification of the runtime user Viewing Runtime User Properties To view runtime user properties: Step 1 Step 2 On the Definitions Runtime User view, highlight the appropriate runtime user, and use one of the following methods: Right-click and choose Properties. -or- On the Details pane, click the hyperlink name on any of the tabs. The Properties dialog box displays. Click the appropriate tab to review the properties Tab General Used By History Displays the credential properties for the runtime user Displays the objects used by the runtime user Displays when the runtime user was created or modified. The column also displays audit log entries that are relevant to the runtime user. Step 3 Click OK to close the dialog box 2-3

84 Defining a Public-key Authenticated Admin Runtime User Account Chapter 2 Managing Terminal Runtime Users Defining a Public-key Authenticated Admin Runtime User Account Use the Public-key Authenticated Admin Runtime User dialog box to define the user credentials required to allow public key authentication and an administrative password is required to perform privileged operations. If a target has set up public key authentication on the remote SSH server, the private key of the Public-key Authenticated Admin Runtime User will be used to form the SSH authentication request. The request is then authenticated against the stored public key on the remote server. If the target does not allow public key authentication, the SSH authentication will fail. To create a Public-key Authenticated Admin Runtime User: Step 1 On the Definitions Runtime Users view, right-click and choose New > Public-key Authenticated Admin Runtime User. The New Public-key Authenticated Admin Runtime User Properties dialog box displays. Figure 2-2 New Public-key Authenticated Admin Runtime User Properties Dialog Box General Tab Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. 2-4

85 Chapter 2 Managing Terminal Runtime Users Defining a Public-key Authenticated Admin Runtime User Account Step 2 On the General tab, specify the following information: Field Display Name Type Owner User name Private key Admin password Enter the display name for the runtime user. This field is populated with the information specified in the Domain and User name text fields. Display-only. Object type User name of the owner of the object. This is typically the person who created the object. Click Browse to launch the Select User or Group dialog box to change the owner. The user name assigned to access the device To the right of the display-only field, click Browse to launch the Load Private Key dialog box to select a private key. Use the Load Private Key dialog box to select the private key file to be used to provide authentication of a public key. If OpenSSH is installed, the key pair is generated by the command line tool "ssh-keygen." The default location of the file is under the unix user's home directory: ~/.ssh/id_rsa See Selecting a Private Key, page Check the Admin password check box and then enter the password assigned to access Privileged EXEC mode on the device. The Privileged EXEC mode provides the password with administrative access privilege. A description of the runtime user account Step 3 Review the following information, as necessary, and click OK to close the dialog box. Used By tab Displays the objects which reference the target. This tab will remain blank until the target is used by an object. See Viewing Used By Properties, page History tab Displays the history of actions taken against the target. This tab remains blank until after the initial target creation. See Viewing Runtime User History, page

86 Defining a Runtime Admin User Chapter 2 Managing Terminal Runtime Users Defining a Runtime Admin User Runtime user records hold the security credentials that are assigned to processes and activities. Use the following instructions define the user credentials required to access a network device. The level of access for the network device is dependant upon the type of password used. To define a Runtime Admin user. Step 1 On the Definitions Runtime User view, right-click and choose New > Runtime Admin User. The New Runtime Admin User Properties dialog box displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 2-3 New Runtime Admin User Dialog Box General Tab Step 2 On the General tab, enter the appropriate runtime user information. Field Display name Type Owner User name Enter the display name for the runtime user. This field is populated with the information specified in the User name text field, but can be overwritten by the user. Display-only. Type of object type User name of the owner of the object. This is typically the person who created the object. Click Browse to launch the Select User or Group dialog box to change the owner. The user name assigned to access the device 2-6

87 Chapter 2 Managing Terminal Runtime Users Defining a Runtime Admin User Field Password Admin password Check the Password check box and then enter the password assigned to access USER mode on the device. This password provides very limited commands to execute. Check the Admin password check box and then enter the password assigned to access administrative privilege mode on the device. For example, on a Cisco IOS device, it is the password assigned to access Privileged EXEC mode on the device. The Privileged EXEC mode provides the password with administrative access privilege. Brief description of the runtime user Step 3 Review the following information, as necessary, and click OK to close the dialog box. Used By tab Displays the objects which reference the target. This tab will remain blank until the target is used by an object. See Viewing Used By Properties, page History tab Displays the history of actions taken against the target. This tab remains blank until after the initial target creation. See Viewing Runtime User History, page

88 Defining a Runtime User Account Chapter 2 Managing Terminal Runtime Users Defining a Runtime User Account The credentials specified for the runtime user are used to store the information about the simple user security context consisting of a user name and password pair and to pass this information to the adapters. This runtime user can be used for database targets when needing database authentication. To create a Runtime User: Step 1 On the Definitions Runtime Users view, right-click and choose New > Runtime User. The New Runtime User Properties dialog box displays. Figure 2-4 New Runtime User Properties Dialog Box General Tab Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 2 On the General tab, specify the following information: Field Display Name Type User name This field is populated with the information specified in the Domain and User name text fields. Display-only. Object type The user name assigned to the user account 2-8

89 Chapter 2 Managing Terminal Runtime Users Defining a Runtime User Account Field Password The password assigned to the user account Note For existing runtime user records, check the check box to enter the new password assigned to the user account. If the password entered is incorrect, then a confirmation dialog box displays stating: "Logon failure: unknown user name or bad password." Note There is no password verification that is done for the simple (generic) runtime user. Therefore, the above message will NEVER be displayed for the runtime user object. A description of the runtime user account Step 3 Review the following information, as necessary, and click OK to close the dialog box. Used By tab Displays the objects which reference the target. This tab will remain blank until the target is used by an object. See Viewing Used By Properties, page History tab Displays the history of actions taken against the target. This tab remains blank until after the initial target creation. See Viewing Runtime User History, page

90 Defining a Windows User Chapter 2 Managing Terminal Runtime Users Defining a Windows User The credentials specified for a runtime user stores the information about the user security context and to pass this information to the adapters. Use the credentials specified for the Windows user to assign run options for processes or activities. To create a Windows User: Step 1 On the Definitions Runtime Users view, right-click and choose New > Windows User. The New Windows User Properties dialog box displays. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 2-5 New Windows User Properties Dialog Box General Tab Step 2 On the General tab, specify the following information, as appropriate: Field Display Name Type Owner User name Name of the Windows user account. This field is populated with the information specified in the Domain and User name text fields. Display only. Type of object User name of the owner of the object. This is typically the person who created the object. Click Browse to launch the Select User or Group dialog box to change the owner. The user name assigned to the user account 2-10

91 Chapter 2 Managing Terminal Runtime Users Defining a Windows User Field Password Domain The password assigned to the user account Note For existing runtime user records, check the check box to enter the new password assigned to the user account. If the password entered is incorrect, then a confirmation dialog box displays stating: "Logon failure: unknown user name or bad password." The Windows domain in which the user account resides Brief description of the Windows user account Step 3 Review the following information, as necessary, and click OK to close the dialog box. Used By tab Displays the objects which reference the target. This tab will remain blank until the target is used by an object. See Viewing Used By Properties, page History tab Displays the history of actions taken against the target. This tab remains blank until after the initial target creation. See Viewing Runtime User History, page The new runtime user displays in the list of runtime user accounts on the Definitions Runtime User view. 2-11

92 Managing Runtime User Definitions Chapter 2 Managing Terminal Runtime Users Managing Runtime User Definitions Use the following procedures to viewing and modifying runtime user definitions. Modifying a Runtime User Record Use the Definitions Runtime Users view to display the runtime user properties and modify the runtime user records. To modify a runtime user credentials: Step 1 Step 2 Step 3 In the Definitions Runtime Users view, highlight the appropriate runtime user record, right-click and choose Properties. The selected [Runtime User] Properties dialog box displays. On the General tab, modify the appropriate information, as necessary. Confirm the changes, and then click OK to close the dialog box. Deleting a Runtime User Use the Definitions Runtime Users view to delete a runtime user record. Step 1 Step 2 In the Definitions Runtime Users view, highlight the appropriate runtime user, right-click and choose Delete. The Confirm Delete dialog box displays. Click Yes to confirm the deletion. Viewing Used By Properties Use the Used By tab to display the objects that directly reference the selected runtime user in their configuration. Because the Used By tab displays objects in a tree view, users can also display the objects which directly reference the top level objects for the selected object. The objects at the top level are the objects that reference the selected object directly, but users can expand the listed objects and see their referenced objects. Example: If object A is used by objects X and Y and object X is used by object Q, then on the property pages of object A, the user will see X and Y listed. If a user expands (+) object X, then object Q will display. 2-12

93 Chapter 2 Managing Terminal Runtime Users Managing Runtime User Definitions To view used by objects: Step 1 Step 2 In the Definitions Runtime Users view, highlight the appropriate runtime user, right-click and choose Properties. The [Runtime User] Properties dialog box displays. Click the Used By tab to view the objects which reference the runtime user. Object Display name Type Name of the object Type of object Step 3 Step 4 To view information about an object, highlight the object, right-click and choose Properties. The display-only dialog box displays the properties of the object. Click OK to close the dialog box. Viewing Runtime User History Use the History tab to view a history of changes that have been made to the runtime user. Step 1 Step 2 In the Definitions Runtime Users view, highlight the appropriate runtime user, right-click and choose Properties. The [Runtime User] Properties dialog box displays. Click the History tab to view the changes made to the runtime user. The following information about the history of the runtime is displayed: Column Created by Created time Time User Type The user name of the person who created the object The date and time the object was created The date and time the action occurred The user name of the person that performed the action The action that occurred Information about the action that was performed Step 3 Step 4 To view the audit history for a specific action, highlight the appropriate time, right-click and select Properties. Click OK to close the dialog box. 2-13

94 Managing Runtime User Definitions Chapter 2 Managing Terminal Runtime Users 2-14

95 CHAPTER 4 Using Terminal Adapter Activities The Terminal adapter allows TEO to run commands and script activities on a system or network device that has Secure Shell (SSH) enabled. The Terminal adapter also contains three session-based activities which allow users to open new SSH/Telnet sessions and interact with the previously opened sessions. SSH and Telnet leverage the same command execution activities differentiated by the target type they are deployed against. For example, an IOS target can have SSH or telnet optionally configured. TEO requires SFTP to be configured on the Unix/Linux system in order to execute SSH activities. SFTP is not needed for the SSH/Telnet Terminal Session activities. This chapter provides instructions for defining all Terminal adapter activities, instructions for completing the property pages for each specific activity, and instructions on viewing the activity results. Terminal Adapter Activities, page 4-2 Defining Secure Shell (SSH) Activities, page 4-3 Defining Terminal Activities, page 4-22 Managing Activity Definitions, page 4-33 Viewing Activity Instance Information, page

96 Terminal Adapter Activities Chapter 4 Using Terminal Adapter Activities Terminal Adapter Activities When defining an activity in the process workflow, the properties pane contains property pages that are specific to the selected activity. The following table displays the activities that are provided by the Terminal adapter. To properly run script and command activities, TEO requires the Secured File Transfer Protocol (SFTP) to be configured on the SSH server. It is not needed for the SSH/Telnet Terminal Session activities. Activity Secure Shell Activities Execute Unix/Linux SSH Command Specifies a Unix/Linux SSH command to execute See Defining the Execute Unix/Linux SSH Command Activity, page 4-3. Execute Unix/Linux SSH Script Specifies a Unix/Linux SSH script to execute See Defining the Execute Unix/Linux SSH Script Activity, page Get File Retrieves files from a Unix/Linux system target to transfer to a specified local directory See Defining the Get File Activity, page Put File Pushes local files to a Unix/Linux system target See Defining the Put File Activity, page Close Terminal Session Execute Terminal Command(s) Open Terminal Session Terminal Activities Closes a Terminal session opened by a previous Open Terminal Session activity See Defining the Close Terminal Session Activity, page Sends commands to a terminal command session started by a previous Open Terminal Session activity See Defining the Execute Terminal Command(s) Activity, page Starts an SSH session on a selected Terminal target See Defining the Open Terminal Session Activity, page Common Wildcard Expressions The following table describes are commonly used wildcard special characters that display according to the selected activity, such as the Get File or Put File activities. Character * Match Any Character # Match Any Single Digit? Match Any Single Character 4-2

97 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Defining Secure Shell (SSH) Activities Use the following activities to execute commands against Unix/Linux System Target or Terminal Target using the SSH server. Defining the Execute Unix/Linux SSH Command Activity, page 4-3 Defining the Execute Unix/Linux SSH Script Activity, page 4-10 Defining the Get File Activity, page 4-14 Defining the Put File Activity, page 4-18 Defining the Execute Unix/Linux SSH Command Activity Use the Execute Unix/Linux SSH Command activity to specify a SSH command to execute. To properly run this activity, TEO requires SFTP to be configured on the SSH server. This activity is only supported against the Unix/Linux system target. Korn Shell is also required. Pipe is not supported by the Execute Unix/Linux SSH Command activity. If the user needs to execute pipe in an activity, it is recommended that the user places the pipe in the Execute Unix/Linux SSH Script activity. For example, the user can enter "ps -ef " in the Execute Unix/Linux SSH Command activity, but if the user needs to execute "ps -ef grep myusename" then, that information should be placed in the Execute Unix/Linux SSH Script activity. To define the Execute Unix/Linux SSH Command activity: Step 1 On the Toolbox pane, under Secure Shell (SSH), select the Execute Unix/Linux SSH Command activity, then drag and drop the activity onto the Workflow pane. The Execute Unix/Linux SSH Command property page display. Figure 4-1 Execute Unix/Linux SSH Command Properties Page General Tab 4-3

98 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Step 2 On the General tab, enter the following information: Field Display name Type Name of the activity Display-only. Type of activity Brief description of the activity Step 3 Click the Command tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 4-2 Execute Unix/Linux SSH Command Properties Page Command Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page

99 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Step 4 On the Command tab, specify the command line properties used to execute an activity on a local working directory on the SSH server. Field Command to execute on the target Local working directory on target Command line arguments Time out if not completed within Enter the actual command to execute an activity on the SSH server. (120 character limit) Example:1 If your local working directory is: /home/myusername/myappdata and the command is /myapppath/myshellscript.sh the full path is: /home/myusername/myappdata/myapppath/myshellscript. sh. Example:2 on Unix systems: ls /usr/bin/ls If your command is located at the directory of: /mycommandpath and the command is mycommand the full path is: /mycommandpath/mycommand Enter the path to the local working directory on the SSH server where the command will be executed. If the path is left blank, the default directory will be user login directory on the SSH server. Enter the collection of argument values for the command. Add Click this button and choose one of the following to launch the Select Argument to Add dialog box. Enter the appropriate command in the text field or click the Reference tool to select from the list. See Adding a Script Argument, page Edit Select a command line argument from the list and click this button to modify the command argument in the Select Argument to Add dialog box. SeeModifying a Script Argument, page Remove Select a command line argument from the list and click this button to remove the command argument from the list. Removing a Script Argument, page Remove All Click this button to remove all the script arguments from the list. Note For an example of the script arguments, see Script Argument Example, page Enter a value or use the scroll buttons to specify the time frame to wait for the action to complete before timing out. Note Select the time unit link to adjust the time unit (seconds, minutes, or hours). 4-5

100 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Field Time out if no available session within Fail on non-zero return code Enter a value or use the scroll buttons to specify the time frame to wait for the activity to complete if there is no available session. The cause for no available session may be the setting "max allowed concurrent sessions" on the target has been reached. Check this check box to configure the activity to fail when a return code having a non-zero value is received. Step 5 Click the Target tab to continue. Figure 4-3 Execute Unix/Linux SSH Command Properties Page Target Tab Step 6 On the Target tab, specify whether the process target should be used or overridden with a different target: Option Use an existing open session Select the radio button and then select a session activity from the Execute on activity target drop-down list to indicate the activity should execute on the selected Open Terminal Session activity. Open a new open session Select this radio button and then choose one of the following options to indicate the target on which the activity should execute. Execute on the process target Select this radio button to use the same target that was specified in the process definition. 4-6

101 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Option Execute on activity target Executed on this target Execute on this target reference Execute on this target group Select this radio button to execute this activity on the same target as one of the earlier activities in the process. The selected target overrides the target specified in the process definition. Select this radio button and then select the appropriate target from the drop-down list to specify where the process should be executed. Note To view the properties for the selected target, click the Properties tool. See Chapter 3, Managing Terminal Targets for additional information. Select this radio button and then click the Reference tool launch the Insert Variable Reference dialog box. On the Insert Variable Reference dialog box, expand Process > Target > Properties, select the appropriate target reference property, and click OK. The selected target reference property displays in the text field. Select this radio to execute the process on all members of a selected target group. Note To view the properties for the selected target group, click the Properties tool. To create a new target group for this process, click New > [Target Group Name]. Choose a target using this algorithm Select this radio button to execute the process using one of the options from the drop-down list. Note For algorithm descriptions, see Target Algorithms, page 3-4. Step 7 Click the Credentials tab to continue. 4-7

102 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Figure 4-4 Execute Unix/Linux SSH Command Properties Page Credentials Tab Step 8 On the Credentials tab, specify the runtime user whose credentials should be used for process execution: Field Use target's default runtime user Use process runtime user Override process runtime user Select this radio button to use the default runtime user for the target that is specified in the activity Select this radio button to use the credentials for the runtime user that was specified in the process properties Select this radio button to specify a runtime user whose credentials are different than what was specified in the process properties. The selected runtime user overrides the runtime user that was specified for the process. Note To view the properties for the selected runtime user, click the Properties tool. To create a runtime user record for the process, click New > [Runtime User]. For additional information on creating a runtime user, see Chapter 2, Managing Terminal Runtime Users. Step 9 Click the Knowledge Base tab to assign a knowledge base article to the object. Knowledge Base Field Options Property Delete Display-only. Display name for the selected knowledge base article(s) Highlight the appropriate knowledge base article and click the Delete tool to remove the knowledge base article from the display. 4-8

103 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Knowledge Base Field Options Browse Properties Click Browse to launch the Select Knowledge Base dialog box for a list of existing knowledge base articles. For additional information on knowledge base articles, refer to the Cisco Tidal Enterprise Orchestrator Reference Guide. Highlight the appropriate knowledge base article and click the Properties tool to view and/or modify the properties of the defined knowledge base article. The following information is displayed on the Knowledge Base tab. Field Summary Possible cause Possible resolution Related information Brief description of the issue Explanation of the condition that may be causing the issue List of actions that can be performed to attempt to resolve the issue Additional information related to the issue Step 10 On the Result Handlers tab, click one of the following buttons to manage the condition branches on the workflow, as necessary: Button Add Remove Move Up Move Down Adds a condition branch Removes the condition branch from the activity Moves the condition up one position in the list of conditions Moves the condition down one position in the list of conditions Step 11 Click the Save tool to complete the activity definition. Note To view the executed Unix/Linux SSH command results, see Viewing Executed Unix/Linux SSH Command Output, page

104 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Defining the Execute Unix/Linux SSH Script Activity Use the Execute Unix/Linux SSH Script activity to specify a SSH script argument to execute. To properly run this activity, TEO requires SFTP to be configured on the SSH server. I To define the Execute Unix/Linux SSH Script activity: Step 1 On the Toolbox pane, under Secure Shell (SSH), select Execute Unix/Linux SSH Script and drag and drop the activity onto the Workflow pane. The Execute Unix/Linux SSH Script property page displays. Figure 4-5 Execute Unix/Linux SSH Script Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Types Name of the activity Display-only. Type of activity Brief description of the activity 4-10

105 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Step 3 Click the Script tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 4-6 Execute Unix/Linux SSH Script Properties Page Script Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page Step 4 On the Script tab, specify a SSH script argument to execute. Field Local working directory on target Enter the path to the local working directory on the SSH server where the script will be executed. 4-11

106 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Field Script Arguments Script to execute on target Time out if not completed within Time out if no available session within Fail on non-zero return code Enter the collection of argument values for the script. Add Click this button to enter or select the appropriate argument to add to the script. See Adding a Script Argument, page Edit Click this button to modify the script argument. See Modifying a Script Argument, page Remove Click this button to remove the script argument from the list. See Removing a Script Argument, page Remove All Click this button to remove all the script arguments from the list. Note For an example of the script arguments, see Script Argument Example, page Enter the actual script code to use to execute in the specified local working directory. Enter a value or use the scroll buttons to specify the time frame to wait for the action to complete before timing out. Note Select the time unit link to adjust the time unit (seconds, minutes, or hours). Enter a value or use the scroll buttons to specify the time frame to wait for the activity to complete if there is no available session. The cause for no available session may be the setting "max allowed concurrent sessions" on the target has been reached. Check this check box to configure the activity to fail when a return code having a non-zero value is received. Step 5 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Target Specify the target on which to monitor for events that will trigger the process. See Step 5 in Defining the Execute Unix/Linux SSH Command Activity. Credentials Specify the runtime user whose credentials should be used to monitor for changes that will trigger the process. See Step 7 in Defining the Execute Unix/Linux SSH Command Activity. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Note To view the executed Unix/Linux script arguments, see Viewing Executed Unix/Linux SSH Script Output, page

107 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities 4-13

108 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Defining the Get File Activity Use the Get File activity to retrieve files from a Unix/Linux system target to transfer to a specified local directory using either the Secured File Transfer Protocol (SFTP) or Secure Copy Protocol (SCP) if SFTP or SCP is available on the given target. If both protocols are available, SFTP will be used. Note The wildcard * is allowed. For additional information on wildcard expressions, see Common Wildcard Expressions, page 4-2. To define the Get File activity: Step 1 On the Toolbox pane, under Secure Shell (SSH), select Get File and drag and drop the activity onto the Workflow pane. The Get File property page displays. Figure 4-7 Get File Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Types Name of the activity Display-only. Type of activity Brief description of the activity 4-14

109 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Step 3 Click the Get File tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 4-8 Get File Properties Page Get File Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page

110 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Step 4 On the Get File tab, specify the remote files and file path to the local directory to where the files will be copied. Field Remote files on the target to copy from Local windows runtime user for accessing local file systems Local directory to copy files to The list of files on the Unix/Linux system the user wants to retrieve. If a relative path is specified, it will be relative to the product local application data directory. Add Click Add to launch the Enter Remote File to Add dialog box to type the file name to be added to the list. See Adding a Remote File to Get File Activity, page Edit Highlight the appropriate file name and click Edit to launch the Enter Remote File to Add dialog box to modify the file name in the list. Remove Highlight the appropriate file name and click Remove to remove the file name from the list.see Removing Files from Activity, page Remove All Click Remove All to remove all the files in the list. See Removing Files from Activity, page From the drop-down list, select the windows runtime user account that contains the credentials to access local files. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Windows User to create a new Windows User account. See Chapter 2, Managing Terminal Runtime Users. Note The user must have the Log on as batch job and Allow log on locally User Rights Assignment. To adjust the user right assignments, go to: Administrative Tools/Local Security Policy/Security Settings/Local Policies/User Rights Assignment. Specify the file path to the local directory to where the files will be copied. The default file path is relative to the product local application data directory. Example: C:\Documents and Settings\test\Local Settings\Application Data 4-16

111 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Field Overwrite Time out if not completed within Select the appropriate option to determine the circumstances in which the copied file should overwrite any existing file in the local directory. Do not overwrite Indicates the copied file should never overwrite the existing file Always overwrite Indicates the copied file should always overwrite the existing file Pull only if newer Retrieves the file only if the file on the Unix/Linux system is more recent than the local copy. Note This setting may not apply when the SCP protocol is used or a directory copy takes place. Enter a value to specify the time frame to wait for the file transfer to complete before timing out. Large files may cause the file transfer to take longer. Note Select the time unit link to adjust the time unit (seconds, minutes, or hours). Step 5 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Target Specify the target on which to monitor for events that will trigger the process. See Step 5 in Defining the Execute Unix/Linux SSH Command Activity. Credentials Specify the runtime user whose credentials should be used to monitor for changes that will trigger the process. See Step 7 in Defining the Execute Unix/Linux SSH Command Activity. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Note To view the file properties output, see Viewing Get File Output, page

112 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Defining the Put File Activity Use the Put File activity to push local files to a Unix/Linux system target if SFTP or SCP is available on the given target. If both protocols are available, SFTP will be used. If one file in the list fails while uploading, the activity will fail. To define the Put File activity: Step 1 On the Toolbox pane, under Secure Shell (SSH), select Put File and drag and drop the activity onto the Workflow pane. The Put File property page displays. Figure 4-9 Put File Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Types Name of the activity Display-only. Type of activity Brief description of the activity 4-18

113 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Step 3 Click the Put File tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 4-10 Put File Properties Page Put File Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page

114 Defining Secure Shell (SSH) Activities Chapter 4 Using Terminal Adapter Activities Step 4 On the Put File tab, specify the local files and file path to the remote directory to where the files will be copied. Field Local windows runtime user for accessing local file systems Local files on the target to copy from Remote directory on the target to copy files to From the drop-down list, select the windows runtime user account that contains the credentials to access local files. To view the properties for the selected runtime user, click the Properties tool. To create a new runtime user, click New > Windows User to create a new Windows User account. See Chapter 2, Managing Terminal Runtime Users. Note The user must have the Log on as batch job and Allow log on locally User Rights Assignment. To adjust the user right assignments, go to: Administrative Tools/Local Security Policy/Security Settings/Local Policies/User Rights Assignment. The list of files on the local computer to put on remote target systems. If a relative path is specified, it will be a relative to the product local application data directory. Add Click Add to launch the Enter Remote File to Add dialog box to type the file name to be added to the list. See Adding a Local File to Put File Activity, page Edit Highlight the appropriate file name and click Edit to launch the Enter Remote File to Add dialog box to modify the file name in the list. Remove Highlight the appropriate file name and click Remove to remove the file name from the list. See Removing Files from Activity, page Remove All Click Remove All to remove all the files in the list. See Removing Files from Activity, page Specify the file path to the local directory on the target systems where the files will be transferred. An absolute path is recommended. The default file path is relative to the product local application data directory. Example: C:\Documents and Settings\test\Local Settings\Application Data 4-20

115 Chapter 4 Using Terminal Adapter Activities Defining Secure Shell (SSH) Activities Field Overwrite Select the appropriate option to determine the circumstances in which the copied file should overwrite any existing file in the remote target system. Do not overwrite Indicates the copied file should never overwrite the existing file Always overwrite Indicates the copied file should always overwrite the existing file Push only if newer Retrieves the file only if the file on the remote target system is more recent than the local copy. Note This setting may not apply when the SCP protocol is used or a directory copy takes place. Time out if not completed within Enter a value to specify the time frame to wait for the file transfer to complete before timing out. Large files may cause the file transfer to take longer. Note Select the time unit link to adjust the time unit (seconds, minutes, or hours). Step 5 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Target Specify the target on which to monitor for events that will trigger the process. See Step 5 in Defining the Execute Unix/Linux SSH Command Activity. Credentials Specify the runtime user whose credentials should be used to monitor for changes that will trigger the process. See Step 7 in Defining the Execute Unix/Linux SSH Command Activity. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Note To view the file properties output, see Viewing Put File Output, page

116 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Use the following activities to manage terminal sessions or execute commands against network devices using a SSH or Telnet session. Defining the Close Terminal Session Activity, page 4-22 Defining the Execute Terminal Command(s) Activity, page 4-25 Defining the Open Terminal Session Activity, page 4-29 Defining the Close Terminal Session Activity Use the Close Terminal Session activity to close a SSH or Telnet session opened by a previous Open Session activity. The user should always specify a paired Open Terminal Session and Close Terminal Session activity within a process. If a corresponding Close Terminal Session activity for an Open Terminal Session activity is not specified, the SSH session opened by the Open Terminal Session activity will be closed by the Terminal adapter when the process completes. The SSH session also may terminated earlier by the SSH server if the SSH server configuration specified a shorter user idle time. To define the Close Terminal Session activity: Step 1 On the Toolbox pane, under Terminal, select the Close Terminal Session activity, then drag and drop the activity onto the Workflow pane. The Close Terminal Session property page display. Figure 4-11 Close Terminal Session Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Type Name of the activity Display-only. Type of activity Brief description of the activity 4-22

117 Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Step 3 Click the Close Terminal Session tab to continue. Figure 4-12 Close Terminal Session Properties Page Close Session Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page Step 4 On the Close Session tab, specify the appropriate device command or inputs. Field Input Enter the appropriate device command before ending the SSH session. (Example: Exit) Step 5 Click the Session tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. 4-23

118 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities Figure 4-13 Close Terminal Session Properties Page Session Tab Step 6 On the Session tab, select the appropriate Open Terminal Session activity to close or send commands. The Open Terminal Session activity provides the target upon which the SSH session was opened. The Execute Terminal Command(s) and Close Terminal Session activities will run against the same target and runtime user specified in the Open Session activity. Field Session opened by Select the appropriate open session from the drop-down list. Step 7 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Note To view the Close Terminal Session output results, see Viewing Close Terminal Session Output, page

119 Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Defining the Execute Terminal Command(s) Activity Use the Execute Terminal Command(s) activity to send commands to a session started by a previous Open Terminal Session activity. To define the Execute Terminal Command(s) activity: Step 1 On the Toolbox pane, under Terminal, select the Execute Terminal Command(s) activity, then drag and drop the activity onto the Workflow pane. The Execute Terminal Command(s) property page display. Figure 4-14 Execute Terminal Command(s) Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Type Name of the activity Display-only. Type of activity Brief description of the activity 4-25

120 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities Step 3 Click the Command tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Figure 4-15 Execute Terminal Command(s) Properties Page Command Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page Step 4 Specify the following options for the command or input to be sent during an open session. To generate a long output, it is recommended that users include 'terminal length 0' in one of the commands that uses the session before any command that will return a lot of output. If not, then the command will timeout and the generated output will not display in its entirety. Field Input Ends with special character Enter the appropriate commands and inputs that a user can send to an open session. Note To indicate that the command is encrypted, it is recommended that the user creates a hidden string variable. See the Cisco TEO Reference Guide for additional information. Check this check box and then select the appropriate option to place at the end of the lines that is sent with the input. Use options CTRL_A through CTRL_Z. Multiple lines option 4-26

121 Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Field Send all lines as one input Send next line only if previous line succeeded Activity Timeout Individual Command Timeout Preserve activity output Select this radio button to send all lines in the plain text as one input. Select this radio button to send a line as an input if there is a previous line before the input. Enter a value to specify the time frame to wait for the Execute Terminal Command(s) activity to complete before timing out. Enter a value to specify the time frame to wait for an individual user input to be completed before timing out. Check the check box to indicate that the output from the activity should be preserved. If the check box remains unchecked, then the output will not be preserved and cannot be referenced by the user nor the expect results. Note Step 5 To the right of the timeout fields, select the time unit link to adjust the time unit (seconds, minutes, or hours). Click the Expect tab to continue. Figure 4-16 Execute Terminal Command(s) Properties Page Expect Tab 4-27

122 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities The Expect tab displays the configuration used to manage the target command output during the terminal session. Column Name Regular Expression Operation Type User Response Hidden Name of the case defining what to expect Matches the characters in terminal output Note For additional information on regular expressions, see Common Regular Expressions, page 3-5. Displays what operation takes place if an expected regular expression match is encountered in the terminal output User Response Provides input to the terminal and continue execution of the activity Runtime User's Username Allows user to respond with the username of the runtime user for the session Runtime User's Password Allows user to respond with the password of the runtime user for the session Runtime User's Admin Password Allows user to respond with the admin password of the runtime user. If the runtime user doesn t have the admin password, the regular password will be used. Succeeded Complete activity and set its status to Completed Failed (Completed) Complete activity and set its status to Failed (Completed) Failed (Not Completed) Complete activity and set its status to Failed (Not Completed) Displays the defined user input string text or format to be used to perform the substring operation on the match results. This check box is enabled when User Response is selected from the Operation Type drop-down list. Check this check box and enter the string text into the User Response field, which will be used as security-sensitive content for the expect. Step 6 On the Expect tab, click one of the buttons to modify the target command output. Button Add Edit Click Add to launch the Expect dialog box to configure the expect parameters to be added to the list. See Adding an Expect Parameter, page Highlight the appropriate item and click Edit to launch the Expect dialog box to modify the expect parameters in the list. 4-28

123 Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Button Remove Move Up Move Down Highlight the appropriate item and click Remove to remove the item from the list. See Removing an Expect Parameter, page Select a match and then click this button to move the item up list. Select a match and then click this button to move the item down list. Step 7 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Session Specify the appropriate Open Terminal Session activity to close or execute terminal commands. See Step 5 in Defining the Close Terminal Session Activity. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Defining the Open Terminal Session Activity Use the Open Terminal Session activity to start an SSH session on a given Terminal target via a SSH or Telnet protocol client. The subsequent Execute Terminal Command(s) and Close Terminal Session activities will run in the SSH or Telnet session. To define the Open Terminal Session activity: Step 1 On the Toolbox pane, under Terminal, select the Open Terminal Session activity, then drag and drop the activity onto the Workflow pane. The Open Terminal Session property page display. 4-29

124 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities Figure 4-17 Open Terminal Session Properties Page General Tab Step 2 On the General tab, enter the following information: Field Display name Type Name of the activity Display-only. Type of activity Brief description of the activity Step 3 Click the Open Terminal Session tab to continue. Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. 4-30

125 Chapter 4 Using Terminal Adapter Activities Defining Terminal Activities Figure 4-18 Open Terminal Session Properties Page Open Session Tab Note Click the Reference tool to choose a defined variable or reference an object within the process on the Insert Variable Reference dialog box. For additional information, see Inserting an Activity Variable Reference, page Step 4 On the Open Session tab, modify the time constraints for the activity or command. Field Activity Timeout Time out if no available session within Check this check box and then enter a value to specify the time frame to wait for the Open Terminal Session activity to complete before timing out. (Default: 5 minutes) Note To the right of the timeout fields, select the time unit link to adjust the time unit (seconds, minutes, or hours). Enter a value or use the scroll buttons to specify the time frame to wait for the activity to complete if there is no available session. The cause for no available session may be the setting "max allowed concurrent sessions" on the target has been reached. 4-31

126 Defining Terminal Activities Chapter 4 Using Terminal Adapter Activities Step 5 Complete the appropriate information in the following tabs, as necessary, and then click the Save tool to complete the activity definition. Target Specify the target on which to monitor for events that will trigger the process. See Step 5 in Defining the Execute Unix/Linux SSH Command Activity. Credentials Specify the runtime user whose credentials should be used to monitor for changes that will trigger the process. See Step 7 in Defining the Execute Unix/Linux SSH Command Activity. Knowledge Base Choose the appropriate knowledge base article to associate with the process. See Step 9 in Defining the Execute Unix/Linux SSH Command Activity. Result Handlers Click the appropriate buttons to manage the condition branches on the workflow. See Step 10 in Defining the Execute Unix/Linux SSH Command Activity. Note To view the executed Open Terminal Session output results, see Viewing Open Terminal Session Output, page

127 Chapter 4 Using Terminal Adapter Activities Managing Activity Definitions Managing Activity Definitions The information in this section provide instructions on modifying the activity properties. Use the activity property page to perform the following functions: Modify activity properties Inserting variable references Add script arguments to an activity Adding files to an activity Adding expect parameters Modifying a Terminal Adapter Activity Modifying a process does not automatically modify an activity. Activity definitions are included in a process definition and the activity properties must be modified separately from the process properties. Activities can only be modified in the Process Editor. With the appropriate rights from the Operations view, the Process Editor is launched when accessing the process properties. When user rights are restricted, the Process Viewer is launched with the properties displaying a display-only view after determining that the user cannot edit the activity. Step 1 Step 2 Step 3 To modify an activity, use one of the following methods: On the Definitions Process view, highlight the appropriate process, right-click and choose Edit. -or- On the Operations workspace, select a process from any of the four process views, right-click and choose Edit. The Process Editor dialog box displays. On the Workflow pane, select the appropriate activity, and modify activity properties, as necessary, and click Save. Make any additional changes, as necessary, and click Exit to close the Process Editor. 4-33

128 Managing Activity Definitions Chapter 4 Using Terminal Adapter Activities Inserting an Activity Variable Reference The Reference icon to the right of a text field indicates that the field can be populated by referencing a defined variable or the property of another activity or process. Use the Insert Variable Reference dialog box to select a defined variable or reference an object to populate a field. The OK button does not activate until a valid property or variable is selected. The available activity reference objects In addition to TEO activity instance standard exposed properties, the Execute Terminal Command(s) activity instance will have the following exposed properties: The Activity Expect Results property folder in the list will contain the matched results of the Expect configurations defined in the activity. Users can select the name of an Expect configuration to reference a row and use column name to reference a cell. To insert an activity variable reference: Step 1 To the right of a field on a property page, click the Reference tool. The Insert Variable Reference dialog box displays. Figure 4-19 Insert Variable Reference Dialog Box Note The Required Value icon displayed on a tab or page indicates that the field is required and is either missing a value or contains an invalid value. Step 2 Check the Show Advanced check box to display all items that are available for referencing. 4-34

129 Chapter 4 Using Terminal Adapter Activities Managing Activity Definitions Step 3 Step 4 If the check box is not checked, then only the most commonly-used items are displayed for activities, processes or events. Expand the Process or Workflow items to display the reference objects for the activity. The properties that display depend on selected activity. From the list of displayed objects, select the appropriate property. Reference Variable Activity Expect Results Contain the matched results of those Expect configurations defined in this activity Match Name The name of a matched Expect configuration Match Result The match result of an Expect configuration Audit Starts Date and time the process audit starts Audit Successes Indicates the number of successful audits Created By User name or the owner of the activity of the activity End Time Date and time the activity stopped Error Information of the error that has occurred Group Name Name of toolbox activity group Instance Cancelled Indicates the process was cancelled manually Instance Failed Indicates the process has failed Instance Failed (Completed) Indicates the process has failed but the process execution was completed Instance Failed (Not Completed) Indicates the process has failed and did not complete the process execution Last Match Name Displays the last name of a matched Expect configuration Last Match Result Displays the last matched result of an Expect configuration Modified By User name of the individual who modified the activity Name Name of the activity that opened the session Output Terminal output of during opening session period (string type) Start Time Date and time the activity was started Target Name of the target Timed Out Indicates whether the activity timed out Step 5 Click OK to add the related text field populates with the selected value. 4-35

130 Managing Activity Definitions Chapter 4 Using Terminal Adapter Activities Adding a Script Argument Script arguments are a property for SSH activities. The Add button on these activities launches the Select Argument to Add dialog box for users to specify the script arguments to be added to the list on the specified SSH activity. To add a script argument: Step 1 On the appropriate SSH activity property page, click Add. The Select Arguments to Add dialog box displays. Figure 4-20 Select Argument to Add Dialog Box Step 2 Step 3 Specify the script argument value for the script. Click OK. The script argument is added to the command line argument list on the activity property page. Modifying a Script Argument Use the Select Argument to Add dialog box to modify existing script arguments added to the SSH script or command activities. To modify a script argument: Step 1 Step 2 On the appropriate SSH activity property page, under the Arguments section, highlight the appropriate the script argument, and click Edit. The Select Argument to Add dialog box displays. Modify the information on the variable, as necessary, and click OK. The modified script argument displays in the activity tab. Removing a Script Argument Removing a script argument from an activity does not delete the object from the TEO server. To delete the object, refer to the appropriate object definition section. To remove a script argument: On the activity property page tab, highlight the appropriate the argument, and click Remove. 4-36

131 Chapter 4 Using Terminal Adapter Activities Managing Activity Definitions The selected script argument is removed from the list on the activity property page. Script Argument Syntax Script Argument Example Any command-line arguments can be accessed as shell variables inside a script. The following table contains script arguments which can be used inside a script. Syntax ${0} The name of the script being run $?name Returns 1 if the variable name is defined, or 0 if it is not defined $n The value of the n argument passed to the script $argv[n] The value of the n argument passed to the script $#argv The number of arguments passed to the script $* All the arguments supplied to the script $$ Process identification number (useful for making temporary files with unique names) The following is an example of a script containing four arguments. For additional examples and information, see Script arguments and other special variables. Script to Execute #! /bin/csh echo ${0} echo "Number of arguments is $#argv" echo $2 echo $argv[2-3] echo $argv[$] exit Script argument % argex.csh "hello world" "(300:400,~100)" argex.csh Number of arguments is (300:400,~100) 4-37

132 Managing Activity Definitions Chapter 4 Using Terminal Adapter Activities Adding a Remote File to Get File Activity The Get File activity copies files from remote target systems to a local directory. The Add button on this activity launches the Enter Remote File to Add dialog box for users to specify the file name to be added to the list on the Get File activity. To add a file: Step 1 On the Get File property page, click Add. The Enter Remote File to Add dialog box displays. Figure 4-21 Enter Remote File to Add Dialog Box Step 2 Step 3 In the Remote File field, enter or select the file name to be added to the list. Click OK. The file is added to the list of remote files to be retrieved by the Get File activity. Adding a Local File to Put File Activity The Put File activity copies files from a local directory onto a remote target system. The Add button on this activity launches the Enter Local File to Add dialog for users to specify the file name to be added to the list on the Put File activity. To add a file: Step 1 On the Put File property page, click Add. The Enter Local File to Add dialog box displays. Figure 4-22 Enter Local File to Add Dialog Box Step 2 Step 3 In the Local File field, enter or select the file name to be added to the list. Click OK. 4-38

133 Chapter 4 Using Terminal Adapter Activities Managing Activity Definitions The file is added to the list of local files to be retrieved by the Put File activity. Removing Files from Activity Use the following steps to remove files specified on the Get File and Put file activities to be copied. Removing a Single File Removing all Files To remove a single file: Under one of the following, highlight the appropriate file, and then click Remove. Remote files on the target to copy Local files on the target to get The selected file is removed from the Get File or Put File tab. To remove all files: Under one of the following, click Remove All. Remote files on the target to copy Local files on the target to get All the files under the appropriate section are removed from the list. 4-39

134 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information This section describes what the user should expect to see after a process with a terminal activity is launched. Certain activities generate and display additional activity instance information for review by users. For example, there will be certain activities that generate information based on the defined properties of the activities. In those situations, the activity instance properties will display the display-only configuration properties as well as the generated results of the configuration properties. Viewing Activity Status After a process is launched, status and color indicators display on the console to indicate the current status for each process and activity instance. Status Indicators The State column displays the status of the individual process and activity. The following indicators definitions display on the Results pane. State Succeeded Running Failed (Not Completed) Failed (Cancelled) Process has completed successfully Process is in progress Displays when the process has failed and did not complete the process execution Displays when the process is cancelled manually Color Indicators The colors associated with the individual activities indicate the status of the process instances. The following default colors display: Color Indicator Blue Green Red Orange Process is in progress Process has completed successfully Process has failed and did not complete the process execution Process has stopped. Note To modify the fonts and colors on the Activity View status display, see Customizing the Fonts and Colors in the Cisco Tidal Enterprise Orchestrator Reference Guide. 4-40

135 Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information Viewing Activity Instance Properties The activity instance properties displayed from the Activity View are display-only. To view activity instance properties: Step 1 On the Operations workspace, select any of the four activity views to display the activity instances on the Results pane. Activity View View Triggered View Adhoc View All View Scheduled Displays all process or activity instances that were executed (manually or automatically) and are in progress, have successfully completed, or failed during the selected time period Displays all process or activity instances that were executed manually and are in progress, have successfully completed, or failed during the selected time period Displays all process, activity, and scheduled process and activity instances that are in progress, have successfully completed, or failed during the selected display time period Displays all process or activity instances that are in progress, have successfully completed, or failed and are also scheduled to execute during the selected time period Step 2 Step 3 On the Results pane, expand the appropriate activity instance to display the related activities. Highlight the appropriate activity, and use one of the following methods: Double-click the appropriate activity instance. Right-click and choose Observe. On the Details pane, click the hyperlink of any item on tabs. The [Activity Name] Properties dialog box displays. Viewing Close Terminal Session Output When the Close Terminal Session activity is launched, the results of the matched expect configurations are displayed from the Operations Workspace activity instance view. To view the Close Terminal Session results: Step 1 Step 2 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Close Terminal Session activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Close Terminal Session dialog box displays. 4-41

136 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities Step 3 Click the Output tab to display the results of the matched expect configurations. Figure 4-23 Close Terminal Session Instance Properties Page Output Tab The following information is displayed in the Expect results table: Column Expect Name Match Result The name of an Expect configuration The match result of an Expect configuration The Output box displays the terminal output during the opening session period. Viewing Executed Terminal Command Output When the Execute Terminal Command activity is launched, the results of the matched expect configurations are displayed from the Operations Workspace activity instance view. To view the Executed Terminal Command results: Step 1 Step 2 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Execute Terminal Command activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Execute Terminal Command dialog box displays. 4-42

137 Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information Step 3 Click the Output tab to display the results of the matched expect configurations. Figure 4-24 Execute Terminal Command Instance Properties Page Output Tab The following information is displayed in the Expect results table: Column Expect Name Match Result The name of an Expect configuration The match result of an Expect configuration To view the properties of an expect, highlight the appropriate expect, and click Properties. The Output box displays the terminal output during the opening session period. Viewing Executed Unix/Linux SSH Command Output When the Execute Unix/Linux SSH Command activity is launched, the results of the executed SSH command are displayed from the Operations Workspace activity instance view. To view the Unix/Linux SSH Command results: Step 1 Step 2 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Execute Unix/Linux SSH Command activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. 4-43

138 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities Step 3 The Execute Unix/Linux SSH Command dialog box displays. Click the Command Output tab to display the executed SSH command line and the display-only activity properties used to generate the results. Figure 4-25 Execute Unix/Linux SSH Command Instance Properties Page Command Output Tab The following information is displayed: Field Command return status code Command output Exit status return code of the command execution String property that captures the output from command execution Viewing Executed Unix/Linux SSH Script Output When the Execute Unix/Linux SSH Script activity is launched, the results of the executed SSH script argument are displayed from the Operations Workspace activity instance view. To view the Unix/Linux SSH Script results: Step 1 Step 2 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Execute Unix/Linux SSH Script activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Execute Unix/Linux SSH Script dialog box displays. 4-44

139 Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information Step 3 Click the Script Output tab to display the executed SSH script argument and the display-only activity properties used to generate the results. Figure 4-26 Execute Unix/Linux SSH Script Instance Properties Page Script Output Tab The following information is displayed: Field Script exit status code Script output Exit status return code of the script execution String property that captures the output from script execution Getting Exit Status when Executing Unix/Linux SSH Scripts Every command returns an exit status (sometimes referred to as a return status. A successful command returns a 0, while an unsuccessful one returns a non-zero value that usually may be interpreted as an error code. Well-behaved UNIX commands, programs, and utilities return a 0 exit code upon successful completion, though there are some exceptions. When using the Execute Unix/Linux SSH Script activity, the user has to manually capture the command exit status. The method of capturing the exit status depends on the shell the script uses. The following example are the steps to use when executing a command in a script. Example: To capture a KSH exit status #!/usr/bin/ksh ls -l agc exit $? The result from the example is the same as if the user runs ls -l abc in the Execute Unix/Linux SSH Command. The last line of exit $? is to capture the exit status code of the ls command. 4-45

140 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities Viewing Get File Output When the Get File activity is launched, the file transfer results of the Get File activity are displayed from the Operations Workspace activity instance view. To view the Get File results: Step 1 Step 2 Step 3 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Get File activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Get File dialog box displays. Click the Result tab to display the Get File output properties from the file transfer and the display-only activity properties used to generate the results. Figure 4-27 Get File Instance Properties Page Result Tab The following information is displayed: File Transfer Protocol used in getting files Field File Transfer Protocol The SFTP or SCP protocol used to transfer the file(s) Results Field Local File Name Remote File Name Name of file as it was saved on the local computer Name of file as it was saved on the remote host computer 4-46

141 Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information Field Transferred Comment Indicates the status of the file transfer from a remote host computer onto the local computer Any comments about the transferred file Viewing Open Terminal Session Output When the Open Terminal Session activity is launched, the results of the matched expect configurations are displayed from the Operations Workspace activity instance view. To view the Open Terminal Session results: Step 1 Step 2 Step 3 In the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Open Terminal Session activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Open Terminal Session dialog box displays. Click the Output tab to display the results of the matched expect configurations. Figure 4-28 Open Terminal Session Instance Properties Page Output Tab The following information is displayed in the Expect table: Column Expect Name Match Result The name of an Expect configuration The match result of an Expect configuration 4-47

142 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities The Output box displays the terminal output during the opening session period. Viewing Put File Output When the Put File activity is launched, the file transfer results of the Put File activity are displayed from the Operations Workspace activity instance view. To view the Put File results: Step 1 Step 2 Step 3 On the Operations workspace, click the Activity Views folder. Use one of the following methods: Highlight the Put File activity instance, right-click and choose Properties. -or- Double-click the appropriate activity instance. The Put File dialog box displays. Click the Result tab to display the Put File output properties from the file transfer and the display-only activity properties used to generate the results. Figure 4-29 Put File Instance Properties Page Result Tab The following information is displayed: File Transfer Protocol used in getting files Field File Transfer Protocol The SFTP or SCP protocol used to transfer the file(s) 4-48

143 Chapter 4 Using Terminal Adapter Activities Viewing Activity Instance Information Results Field Local File Name Remote File Name Transferred Comment Name of file as it was saved on the local computer Name of file as it was saved on the remote host computer Indicates the status of the file transfer from the local computer into the remote host computer Any comments about the transferred file 4-49

144 Viewing Activity Instance Information Chapter 4 Using Terminal Adapter Activities 4-50

145 CHAPTER 5 Troubleshooting Terminal Adapter The purpose of this chapter is to provide some basic steps to review when analyzing the output of a failed process or activity. Correcting Open Session Activity Timeout Error, page 5-2 Activity Output does not match Expect Prompts, page 5-3 Expect Prompt Command Error, page 5-4 Target Connection Pattern Prompt Prefix Error, page 5-5 Execute Terminal Command Activity Timed Out, page 5-6 If the solutions do not work, then we recommend contacting Cisco support. 5-1

146 Correcting Open Session Activity Timeout Error Chapter 5 Troubleshooting Terminal Adapter Correcting Open Session Activity Timeout Error Error This activity has failed because the session activity has timed out. Solution This is a basic issue that occurs when the user did not enter enough time when defining the properties of the Open Session activity. To modify the Open Session activity properties Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Highlight the process and use one of the following steps: Double-click the process. -or- Right-click and choose Edit. The selected process opens in the Process Editor. On the Workflow pane, locate the appropriate Open Session activity. On the activity Properties pane, click the Open Sessions tab. In the Activity timeout field, increase the amount of time necessary to run the process before the activity times out. Click the Save tool to save and the Start tool to run the saved process. Close the Process Editor and return to the Operations workspace to observe the process status. 5-2

147 Chapter 5 Troubleshooting Terminal Adapter Activity Output does not match Expect Prompts Activity Output does not match Expect Prompts Error This activity has failed, please check the output or the expect results table. If the output does not match the expect prompts, the activity will timeout. To review the expect result properties Step 1 Step 2 Step 3 Step 4 Step 5 On the Operations Processes view, highlight the appropriate process, right-click and choose Observe. On the Workflow pane, locate the appropriate Execute Terminal Command activity. On the activity Properties pane, click the Output tab. Under Expect result table, highlight the appropriate displayed result, and click Properties. The Expect properties dialog box displays. Review the Match before field to review the expect properties to verify whether the activity contains valid expects. Solution This is not an easily determined problem, because the output doesn t clearly explain the error. After verifying the expects in the Expect Result Properties dialog box, modify the expects and then re-run the process. To modify the expects: Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Highlight the process and use one of the following steps: Double-click the process. -or- Right-click and choose Edit. The selected process opens in the Process Editor. On the Workflow pane, locate the appropriate Execute Terminal Command activity. On the activity Properties pane, click the Expect tab. Highlight the appropriate expect, click Edit and then modify the information in the Regular Expression field. Click OK to close the dialog box and then click the Save tool to save the process. Click the Start tool to run the saved process. Close the Process Editor and return to the Operations workspace to observe the process status. 5-3

148 Expect Prompt Command Error Chapter 5 Troubleshooting Terminal Adapter Expect Prompt Command Error Error This activity has failed, please check the output or the expect result table to see the error details. Solution For this particular error, the user should not concentrate on the match results, but the expect command in the Expect Result Properties dialog box. The information in the dialog is Cisco IOS data and the user user must be familiar with Cisco IOS, otherwise he or she will not understand the error. To review the expect result properties Step 1 Step 2 Step 3 Step 4 On the Operations Processes view, highlight the appropriate process, right-click and choose Observe. On the Workflow pane, locate the appropriate Execute Terminal Command activity. On the activity Properties pane, click the Output tab. Under Expect result table, click Properties to review the detailed error message for the prompt command. Figure 5-1 Expect Properties Dialog Box Step 5 Review the expect properties to determine the next course of action based on the Cisco IOS data. 5-4

149 Chapter 5 Troubleshooting Terminal Adapter Target Connection Pattern Prompt Prefix Error Target Connection Pattern Prompt Prefix Error Error This activity has timed out while waiting for expected output. This error is generated because the activity was waiting for data before successfully completing the activity. Solution Before continuing, verify that the activity simply isn t timing out too quickly. If so, then modify the time entry in the Activity timeout field on the activity property page in the Process Editor. If the amount of time in the activity is sufficient, then compare the information on the Output tab to the regular expression and the operation type on the Expect tab. If the expects do no match, then it will be necessary to modify the appropriate prompt prefixes. Please note in the following examples that the regular expressions in both the Prompt expects are different than what was generated on the output. Figure 5-2 Example Output Tab Figure 5-3 Example Expect Tab 5-5