EMC Voyence Integration Adaptor Version 2.0.0 EMC SMARTS P/N 300-007-379 REV A03 EMC Corporation Corporate Headquarters Hopkinton, MA 01748-9103 1-508-435-1000 www.emc.com
COPYRIGHT Copyright 2008 EMC Corporation. All rights reserved. Published October 2008 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.
TABLE OF CONTENTS COPYRIGHT... 2 TABLE OF CONTENTS... 3 INTRODUCING EMC SMARTS INTEGRATION ADAPTOR... 4 Introduction...4 System and Platform Requirements...4 VOYENCECONTROL/SMARTS INTEGRATION ADAPTOR... 5 Deployment...5 How the Integration Adaptor Operates...6 Batch Device Synchronization...6 Active (Device) Synchronization...7 Credential Synchronization...7 Event Notification...7 Recommendations for Deployment Scenarios...8 VoyenceControl and Report Advisor - Deployed Separately...8 VoyenceControl and Report Advisor - Collocated...8 Important Information about Synchronization...8 INSTALLING THE SMARTS INTEGRATION ADAPTOR... 9 Installing the Smarts Integration Adaptor...9 Installing the Contextual Launch Scripts for Smarts... 10 CONFIGURING THE SMARTS INTEGRATION ADAPTOR... 11 Configuring the Adaptor... 11 Discovering VoyenceControl in Smarts... 11 Configuring the Integration Adaptor... 11 Step 1: Smarts SAM Connection Configuration... 13 Step 2: Smarts IP AM Connection(s) Configuration... 13 Step 3: VoyenceControl Public API and DS API Connection Configurations... 14 Step 4: Synchronization Options... 15 Step 5: Event Notifications (Optional)... 15 Configuring SMARTS for Contextual Launch... 16 Restarting EMC Smarts Service Assurance Manager Server Service on Windows... 17 Client Tools... 17 Configuring the Service Assurance Manager Dashboard (Web Client)... 20 Advanced Configuration... 21 Customizing Notifications... 21 User-Defined Fields... 21 UNINSTALLING THE SMARTS INTEGRATION ADAPTOR... 22 Uninstall Instructions for Linux and Solaris... 22 Uninstall Instructions for Windows... 22 WHERE TO GET HELP... 23 Where to get help... 23 INDEX... 24
INTRODUCING EMC SMARTS INTEGRATION ADAPTOR Introduction VoyenceControl provides automation and standardization of the network configuration and change management processes. VoyenceControl automates the configuration management at various levels, covering devices such as routers, switches, firewalls, and business policies, such as access and security configuration. The integration adaptor provides the following functionality: Device Synchronization The adaptor ensures that devices found in VoyenceControl are also in Smarts, those found in Smarts are also in VoyenceControl. In addition, the adaptor has reconciled devices between Smarts devices and VoyenceControl devices internally. This provides a mapping used for notifications and contextual launches. Event Notification VoyenceControl events are sent to the notification console in Smarts. Device events are linked to the corresponding Smarts device, while nondevice events, such as Network Create events, are linked with the VoyenceControl server. Credential Synchronization VoyenceControl has strong capabilities for managing device credentials including credential rolling. The adaptor detects when device passwords (community strings) have been changed in VoyenceControl, and propagates those change into Smarts. Contextual Launch The events and device reconciliation (previously mentioned in Device Synchronization), provide a number of launch points from Smarts into the VoyenceControl application. System and Platform Requirements The Integration Adaptor for EMC Smarts requires the following software: EMC VoyenceControl 4.0.1 Hot Fix 1 Supported Operating Systems: Red Hat Enterprise Linux 4 Windows Server 2003 Solaris 10 The Integration Adaptor for EMC Smarts is compatable with the following versions: EMC Smarts IP Availability Manager 7.0 and later EMC Smarts Service Assurance Management Suite 7.1 and later EMC Voyence Report Advisor 2.1.0
VOYENCECONTROL/SMARTS INTEGRATION ADAPTOR Deployment The integration adaptor is middleware that connects to both Smarts and VoyenceControl. It is important to understand the configuration of both products when installing the adaptor. The basic Smarts configuration assumed by the adaptor, is the following: Service Assurance Manager (SAM) IP Availability Manager (IP AM) SAM Adaptor Platform The basic VoyenceControl configuration assumed by the adaptor, is the following: VoyenceControl Server (any configuration) Report Advisor Note: Report Advisor contains the VoyenceControl Data Services API (DS API), which handles bulk export of data, devices, and networks for example, and other query capabilities into VoyenceControl. Configuring the adaptor requires the installer to understand the following connection points: VoyenceControl Public API VoyenceControl DS API Smarts SAM Connection Smarts IP AM Connection The following diagram provides an illustration of the components and connection points. Refer to this diagram when configuring the adaptor.
How the Integration Adaptor Operates After configuring the adaptor, it runs through a series of self-tests to test the connections. When the tests pass, the adaptor becomes functional. If this is the first time the adaptor has been run, it is required that batch synchronization completes before either credential synchronization or active (event-based) device synchronization will function. Due to the potentially long-running and processor intensive nature of full synchronization, it is a manual step to begin the initial synchronization. Event notifications start to run before batch device synchronization has run, but notifications may not be associated with the correct devices before the adaptor has a chance to reconcile devices between the systems. Batch Device Synchronization Batch device synchronization first pulls all devices from Smarts and VoyenceControl, and attempts to match the devices, based upon an algorithm that balances performance with accurate results in a wide variety of environments. For example, batch device synchronization attempts to match devices first by management IP addresses, then through name matching, and finally, it inspects devices down to the interface level to produce a mapping. This reconciliation is then used for multiple purposes. In event notification, it is used to associate device events with the proper Smarts device, even when names or management IP addresses do not match. Credential synchronization uses the mapping to ensure that password changes in VoyenceControl are propagated to the correct Smarts device. It facilitates contextual launch by ensuring that launch points in Smarts lead to the correct devices in VoyenceControl. Once the mapping is complete, devices that are in VoyenceControl, and not in Smarts, are put on the pending list in Smarts. Devices that are in Smarts but not in VoyenceControl, are scheduled for discovery in VoyenceControl. Also, when batch synchronization is complete, the adaptor enables active device synchronization, and credential synchronization. Batch sychronization can be run at any time, if the mapping information becomes outdated for any reason. For example, if the server hosting the integration adaptor was down for a number of days, the device mapping could be out of date, depending on the rate of change in the networks. Run batch synchronization again after rebooting the server to immediately sychronize the systems. Remember, with a large number of devices, this is a long running operation that is computationally expensive, so it is advisable to complete this operation during off-peak hours. Note: Until the initial batch synchronization completes successfully, active synchronization and credential synchronization remain inactive.
Active (Device) Synchronization The integration adaptor listens for events from VoyenceControl, such as, device create events, and certain device state change events, and also events from Smarts that indicate new devices have been added. These events trigger the adaptor to complete the same reconciliation and diff logic as the batch synchronization. As with the batch sync, devices that are added to VoyenceControl that cannot be matched with existing Smarts devices, are put on the Smarts pending list. Devices that are added to Smarts that cannot be matched with existing VoyenceControl devices, are set up for discovery operations in VoyenceControl. See more information under the Recommended Deployment Scenarios on page 8. Credential Synchronization The integration adaptor listens for credential change events in VoyenceControl. Specifically, the password change event is inspected to determine whether the credential change involves an SNMP community string. If so, calls to change the SNMP community string in Smarts are put in a queue for processing. The reason the events are queued instead of acted upon real time, is to handle the case of credential rolls. By design, VoyenceControl has a credential roll feature that could result in large numbers of devices having passwords changed at the same time. However, the logistics of changing passwords in Smarts can be expensive if many devices are changed on a one-off basis. Therefore, credential changes are executed in batch, and at the conclusion of the batch operation and Smarts, is issued a reconfigure command to utilize the new passwords. The time interval is configurable. See the Configuring the Adaptor section on page 11 for more information. Note that Voyence Control manages SNMP credentials as a single pair of one read-only password and one read-write password. In the case where an SNMP credential is modified in VoyenceControl in which the read-only password is set to null, the adaptor will not update the Smarts SNMP community string. This prevents any interruption in monitoring if Smarts is using a different SNMP community string than VoyenceControl to monitor the device. Event Notification The notification console in Smarts typically receives SNMP notifications. The events received from VoyenceControl differ only in the delivery method. The adaptor processes the events, and uses the mapping generated during reconciliation to associate events with the correct Smarts device. The events are delivered via API. Therefore, the SNMP notification adaptor for VoyenceControl is not required for this adaptor.
Recommendations for Deployment Scenarios The Integration Adaptor for EMC Smarts, and the Report Advisor product, cannot be installed on the same machine. This is due to a conflict with the authentication mechanisms used by both the integration adaptor and Report Advisor into the VoyenceControl product. Therefore, there are two main physical deployment scenarios. VoyenceControl and Report Advisor - Deployed Separately For installations of over 500 devices, Report Advisor should be deployed separately from VoyenceControl. For this scenario, VoyenceControl is deployed on one machine, and Report Advisor is deployed on a different machine. For this type of setup, the integration adaptor should be installed on the VoyenceControl machine. VoyenceControl and Report Advisor - Collocated For installations with less than 500 devices, it is acceptable to install VoyenceControl and Report Advisor on the same machine. For this scenario, the integration adaptor must be installed on a separate machine. For this type of setup, it is advisable to install the integration adaptor on the machine running Smarts (the SAM module). However, the adaptor can be installed on any machine. Tomcat 5.5 is required for this typ of installation. The integratino adapter cannot be installed on the same server as Report Advisor. This causes problems for both the adaptor and for Report Advisor. For more information, see Installing the Integration Adaptor on page 9. Important Information about Synchronization Synchronizing devices can potentially be an expensive operation. On new installations, where both Smarts and Voyence Control are new to an environment, performance is much better if the discovery of devices is done in at least one of the systems prior to running batch synchronization. Although the active sync can synchronize them, it takes longer, and is less efficient. More importantly, keep in mind that some of the functionality in the adaptor depends on the synchronization. For example, associating notifications with the proper devices and performing credential rolling depends on the internal mapping. After running batch sychronization, the respective discovery jobs in VoyenceControl and Smarts (the pending list) must be executed for the synchronization to complete. Therefore, it takes some time for the synchronization to settle out unless the pending list and jobs are manually executed and run to completion. An additional consideration is that organization of devices in the systems is better served by planning, rather that the adaptor making the decisions for you. For example, devices organized into certain networks in VoyenceControl is prefered over having the integration adaptor dump them into a single network. The same is true on the Smarts side in terms of IP-AM modules and device classifications. Therefore, plan your synchronization of the products along with the desired organization of the devices in the respective systems.
INSTALLING THE SMARTS INTEGRATION ADAPTOR There are two installation programs used to install the Smarts Integration Adaptor. The first installer is for the integration adaptor itself, and the second is for installing the scripts used for contextual launch into the Smarts User Interface. Installing the Smarts Integration Adaptor Note: The Integration Adaptor for EMC Smarts, and the Report Advisor product, cannot be installed on the same machine. This causes problems for both the adaptor and Report Advisor. Use the following steps to install the Integration Adaptor for Smarts on the Linux, Windows, and Solaris environments. Step Action Command 1 Ensure the following software prerequisites are installed. Tomcat 5.5 Java 1.5.0_13 (JDK) 2 Run the Smarts Integration Adaptor installer. For Linux, enter: bash./smarts_integration_module_2.0.0.220_linux.bin For Solaris, enter: bash./smarts_integration_module_2.0.0.220_solaris.bin For Windows: Double-click Smarts Integration Module 2.0.0.220 Windows.exe 3 At the Introduction page, press the Enter key. 4 At the Summary page, press the Enter key. The Integration Adaptor for Smarts now begins the installation process. When Congratulations! displays, the installation has successfully completed. Once installation is complete, it can be verified by going to the URL listed in the Configuring the Adaptor section on page 11.
Installing the Contextual Launch Scripts for Smarts Note: The Contextual Launch Scripts for EMC Smarts must be installed on the Smarts Service Assurance Manager server. Use the following steps to install the Client for the Integration Adaptor for Smarts on the Linux, Windows, and Solaris environments. Step Action Command 1 Run the Smarts Integration Adaptor Client Installer. For Linux, enter: bash./smarts_integration_module_client_2.0.0.220_linux.bin For Solaris, enter: bash./smarts_integration_module_client_2.0.0.220_solaris.bin For Windows: Double-click Smarts Integration Module Client 2.0.0.220 Windows.exe 2 At the Introduction page, press the Enter key. 3 At the Summary page, press the Enter key. The Client for the Integration Adaptor for Smarts 2.0.0 now begins the installation process. When Congratulations! displays, the installation has successfully completed.
CONFIGURING THE SMARTS INTEGRATION ADAPTOR Configuring the Adaptor The integration adaptor is configured using a browser, by going to the following URL (the SERVER-IP is the IP address where the adaptor was installed; usually the VoyenceControl server): http://[server-ip]:8080/smartsint-2.0 In addition to the configuration console for the adaptor, some configuration is required for the following Smarts components: Domain Manager Administration Console for IP-AM Global Administration Console (SAM) Ensure the SAM Adapter Platform is installed and registered with the Smarts SAM module Discovering VoyenceControl in Smarts The VoyenceControl system must be discovered by Smarts for the event notifications to function properly. One way to do this is to put the VoyenceControl server on the pending list in Smarts. It will likely need to be discovered in Non-SNMP mode to get it into the system. Once VoyenceControl is discovered into Smarts, note the name given by Smarts to the VoyenceControl server. This is needed in the next step. Configuring the Integration Adaptor Go to the URL listed in the Configuring the Adaptor section above. The following screen is displayed. Note that before you can configure anything, the adaptor prompts for a login. The default username and password is admin/admin. This should be changed at some point during the configuration process.
Before going into the configuration options, take a minute to examine this screen. Note that the top four rows indicate the status of each connection from the diagram in the Deployment section on page 5. To the right of the status is a Configure button, used to configure each connection. Below this, the synchronization status and the event notifications status are shown. These also have configurable options, which can be navigated to by the Configure buttons to the right of the status. When the adaptor has detected valid configurations, components are enabled. A successfully configured adaptor appears as in the following graphic. Once the configuration is valid (indicated by all the Tests Passing) event notifications begin flowing. However, synchronization does not begin until the Start button is selected.
Step 1: Smarts SAM Connection Configuration 1. Select the Configure button (next to Smarts SAM Connection) to configure the SAM connection. For any of the configurations, the first screen displays the values for which the adaptor is currently configured. 2. To change any of the values, click Edit on the bottom of the screen. 3. To return to the main page for the integration adaptor, click the Home at any time. The following values can be configured for the SAM connection: Broker IP Address typically the IP address where SAM is installed SAM Domain Name the Smarts adaptor name for SAM SAM Username / Password this needs to be set to an administrator user with full administrator rights VoyenceControl System Name this is the name of the VoyenceControl server as known by Smarts. This is the name you noted from the Discovering VoyenceControl in Smarts section on page 11, when VoyenceControl was discovered in Smarts. 4. Once you are satisfied with the values in the configuration, click Update in the bottom left of the screen. 5. Again, click Home at any time to return to the main page for the adaptor. Step 2: Smarts IP AM Connection(s) Configuration Out of the box, the adaptor is set up for one IP AM. When you select Configure, a list of one IP AM is shown. 1. To edit this, click on the 1 under the ID column. The following values can be configured for the IP AM connection(s): Broker IP Address the IP address where the IP AM is installed (this may be the same box as SAM) AM Domain Name the Smarts adaptor name for this AM AM Username / Password this needs to be set to an administrator user with full administrator rights 2. In the event more than one IP AM is present, click New SmartsAmConfiguration. 3. Configure this second adaptor with the appropriate values. Note: Never delete the last IP AM in the adaptor.
Step 3: VoyenceControl Public API and DS API Connection Configurations Although the VoyenceControl Public API Connection and the VoyenceControl DS API Connections have separate status indicators, the Configure buttons for each, actually point to the same place. The VoyenceControl Configuration has parameters for both connections. The following values can be configured for the VoyenceControl Public API, and DS API Connections: Hostname the IP address of the VoyenceControl application server Username / Password this should be a separate user that has been created through VoyenceControl, with full access rights DS API Hostname the IP address of the VoyenceControl Application Server, which is not dependent on the location of the Report Advisor Server. This is due to the JNDI look up for the DS API being done in the VoyenceControl JNDI instance. DS API Username / Password typically, the username/password for the DS API is the same as for the Public API Auth Conf Location only modify this field if you familiar with the authentication mechanism of VoyenceControl, or if you are specifically instructed to by a qualified support engineer. Cxn Retries once the adaptor tests have passed, it is advisable to reset this value to 5 retries Cxn Retry Interval this is in milliseconds, so a value of 10,000 is equal to 10 seconds Once you have successfully configured the connections, notice that a Start button appears for the Batch Device Synchronization. However, do not select Start yet. Make sure you are satisfied with the default configurations in the following steps. (See the information on page 15.) Also, notice that Event Notifications are flowing from VoyenceControl to Smarts.
Step 4: Synchronization Options The following options are configurable for synchronization: VoyenceControl Network This is the network inside VoyenceControl, into which Smarts devices are discovered. If you enter a network that does not exist in VoyenceControl, it will be created. Voyencecontrol Device Server Discovery operations in VoyenceControl require a device server to be specified. Once the VoyenceControl public API connection is configured properly, the adaptor selects a default device server. This server can be changed here, but it must already exist in VoyenceControl. VoyenceControl Job Scheduling Discovery operations in VoyenceControl are jobs. There are two options for how the adaptor schedules the discovery jobs. Run Upon Approval the jobs are put into a Pending Approval state, and begin when the job is approved in VoyenceControl Run In Maintenance Window the jobs are scheduled to run in the next maintenance window in VoyenceControl Default IP AM When devices are found in VoyenceControl that are not in Smarts, the domain manager is directed to find the VoyenceControl device. Active Synchronization Although the integration adaptor is always listening for events that may trigger device synchronization, it only processes these events at certain times. For example, the default setting is five minutes, but can be changed to happen only once a night. Credential Synchronization The same concept as with Active Synchronization applies, except this applies to credential synchronization. When a password is changed in VoyenceControl, Smarts needs to be notified to continue monitoring the device. Therefore, it is advisbale to keep the default setting of five minutes Step 5: Event Notifications (Optional) Once the adaptor is configured, event notifications begin to flow automatically. To customizae event notifications, see the Advance Configuration section on page 21.
Configuring SMARTS for Contextual Launch Once the scripts have been installed on the SAM server, they must be configured as client tools. Client tools are configured from the Global Manager Administration Console. The client tools provide contextual launch capability in Smarts from the Notification Browser, the Topology Browser, and the Map View of the Topology Browser. Before configuring the client tools, there are some items to note on the VoyenceControl contextual launch. Contextual launch happens through a URL in a browser. Once fed to the browser the web start mechanism takes over, and begins loading the VoyenceControl application from the server. When using the Contextual Launch feature, keep the following in mind. Usually, the user is required to login for each launch of the VoyenceControl application. This contextual launch uses a special launch file that allows use of the Remember Me feature, so users do not have to log in each time. The VoyenceControl application should be closed after each use of the launch so that: The application is ready to launch to the appropriate location on the next use. The extra device information readily available from VoyenceControl is not left on the screen if the operator leaves their workstation. Once in the Global Manager Administration Console, ensure that it is attached to the SAM application. Usually, the drop-down box Manager is pointing to INCHARGE-SA. For each of the client tools, the set of steps are the same, but the values are different. See the specific parameters for each client tool located in the Client Tools section on page 17, then follow these steps. Step Action 1 Under Tools->Client right-click, and select New Client Tool. 2 Type the name of the client tool in the Client Tool text box, and click Next. 3 Choose the program from the drop-down list. 4 Select the profiles you want to add. The admin-profile must be one of the selected profiles. Click Next. 5 Select the appropriate value for the Context object in the drop-down. For example, ICIM_Notification. 6 Use the plus-sign (+) to create the context criteria. These are listed below for each client tool. Click Next. 7 Ensure that the Context object for the Status criteria is the same as the previous screen. Click Next. 8 Do not add any parameters. Click Finish.
After you enter client tools, see the EMC Smarts documentation for how Smarts picks up the changes for the appropriate platform. On Windows, this is restarting the EMC Smarts Service Assurance Manager Server service. See the Restarting EMC Smarts Service Assurance Manager Server Service section on page 17 for more information. Restarting EMC Smarts Service Assurance Manager Server Service on Windows To restart the EMC Smarts Service Assurance Manager Server service: Step Action 1 Open the Control Panel window. 2 Double-click the Administrative Tools icon. The Administrative Tools window opens. 3 Double-click the Services icon. The Services window opens. 4 Right-click the EMC Smarts Service Assurance Manager Server service, and select Restart. The Service Control window opens, and the EMC Smarts Service Assurance Manager Server restarts. Refer to the EMC Smarts documentation for information on how to restart the EMC Smarts Service Assurance Manager Server services on other platforms. Client Tools The following tables contain the settings appropriate for each client tool. Follow the steps in the Configuring SMARTS for Contextual Launch section on page 16, entering the appropriate values at each step. Note: The program name has a.cmd suffix for windows, or a.sh suffix for Linux and Solaris. Voyence Device Info Client Tool Name Voyence Device Info Description Launches VoyenceControl from a notification directly to the device to which the notification was associated Program VCDeviceLaunch Context Criteria Context object: ICIM_Notification Attribute: User Defined 5 Value: [a-za-z0-9]* Status Criteria Attribute: ClassName Value: NCM Context object: ICIM_Notification
Voyence Job Info Client Tool Name Voyence Job Info Description Program Context Criteria Launches VoyenceControl from a notification directly to the job listed in the notification VCJobLaunch Context object: ICIM_Notification Attribute: User Defined 7 Value: [a-za-z0-9]* Status Criteria Attribute: ClassName Value: NCM Context object: ICIM_Notification Voyence Query Client Tool Name Voyence Query Description Program Context Criteria Launches VoyenceControl attempting to look up a device based upon device name or IP address. The client tool is named Voyence Query, because devices in VoyenceControl may or may not match criteria passed into the tool. VCGenericDeviceLaunch Context object: ICIM_Notification Status Criteria Attribute: Class Value: Router Switch Firewall Interface Context object: ICIM_Notification Device Communication Report Client Tool Name Device Communication Report Description Program Context Criteria Launches Report Advisor, and runs the Device Communication Report. This is a record of the communications between VoyenceControl and the device. The main purpose of this is to show outtages. VCRADeviceCommReport Context object: ICIM_Notification Attribute: User Defined 6 Value: [a-za-z0-9]* Attribute: User Defined 4 Value: [a-za-z0-9]* Status Criteria Attribute: ClassName Value: NCM Context object: ICIM_Notification
Device Change Report Client Tool Name Device Change Report Description Program Context Criteria Launches Report Advisor, and runs the Device Change Report. This shows a history of configuration changes on the device in the last 24 hours. Note: By editing the unitsbackparam in the script, the number of days covered by the report can be altered. VCRADeviceChangeReport Context object: ICIM_Notification Attribute: User Defined 6 Value: [a-za-z0-9]* Attribute: User Defined 4 Value: [a-za-z0-9]* Status Criteria Attribute: ClassName Value: NCM Context object: ICIM_Notification Device Compliance Report Client Tool Name Device Compliance Report Description Program Context Criteria Launches Report Advisor, and runs the Device Compliance Report. This is a history of the compliance or non-compliance of the device with policies in VoyenceControl. VCRADeviceComplianceReport Context object: ICIM_Notification Attribute: User Defined 6 Value: [a-za-z0-9]* Attribute: User Defined 4 Value: [a-za-z0-9]* Status Criteria Attribute: ClassName Value: NCM Context object: ICIM_Notification Voyence Device Query Client Tool Name Voyence Device Query Description Program Context Criteria Status Criteria Launches VoyenceControl, attempting to look up a device based upon device name or IP address. This version is for use by the topology browser and the map view. The client tool is named Voyence Device Query, because devices in VoyenceControl may or may not match criteria passed into the tool. VCGenericDeviceLaunchForTopo Context object: UnitaryComputerSystem Context object: UnitaryComputerSystem
Configuring the Service Assurance Manager Dashboard (Web Client) Instructions on configuring the web client to use client tools can be found in the EMC Smarts Service Assurance Manager Dashboard Configuration Guide. The guide is the definitive source for configuring client tools. However, a short version is presented here for a standalone client. Since the dashboard is launched via the browser, the client tool scripts must be located on the machine from which the browser is launched (or accessible through a mapped network drive). Step Action 1 Create a /actions/client directory under your local directory. This is where the client tool scripts will be copied. 2 Add the following parameters to the dashboard.properties file, located in the../incharge7/sam/smarts/tomcat/webapps/templates directory on the Smarts server. com.smarts.clienttoolsinapplet=true com.smarts.webconsole.sitemod=/mylocaldirectory 3 Add the following parameters to the webconsole.properties file, located in the../incharge7/sam/smarts/tomcat/webapps/webconsole directory on the Smarts server. com.smarts.clienttoolsinapplet=true com.smarts.webconsole.sitemod=/mylocaldirectory 4 Copy the client tool scripts from the../incharge7/sam/smarts/local/actions/client to your local machine, and place them in the /mylocaldirectory/actions/client directory you created in step 1. If you need more information, see the section Additional Viewlet Properties in the EMC SAM Dashboard Configuration Guide.
Advanced Configuration Customizing Notifications There is an XML file in the Tomcat directory (where the adaptor is deployed) named Smarts_Transform.xml. This file is the mapping definition of raw VoyenceControl events to the properties used by the integration adaptor. In this file, there are some fields that could be customizable at the installation site. Severity This is the severity level of the event in the Smarts notification log console. 5 is the lowest or normal severity, and 1 is the highest or critical severity. Event Name this is the value shown in the Event column in the notification log Event Text this is the description of the event shown inside the event details Note: Modifying any other field is not advisable. User-Defined Fields There are many user-defined fields in the event notifications populated by the integration adaptor. The adaptor requires these fields to be populated for the contextual launch to function correctly. These settings are only needed if there is a possible conflict with userdefined fields in Event Notifications. By default, the fields are mapped to the same values expected by the client tool launch scripts. These can be changed, however the scripts for contextual launch must also be modified to use the new user defined fields. Note: It is advisable that these user-defined fields remain unchanged. Only in the case of conflicts should the installer take on the additional burden of reconfiguring the contextual launch scripts and the user-defined fields. If you need to change these, use the following example chart, which shows the default configuration out of the box. Field User Defined 3 User Defined 4 User Defined 5 User Defined 6 User Defined 7 Value Network name (not needed by scripts; can be turned off) Network Id (needed only for tools that launch reports) Device Name Device Id (needed only for tools that launch reports) Job Number When changing the user defined fields, follow these steps. Step Action 1 Using the integration adaptor configuration console, change assignments of the user-defined fields. Complete your own chart for the new values that you configure. 2 On the Smarts client machine, find the directory for client tools. This is \InCharge7\SAM\smarts\local\actions\client by default. 3 For each script that begins with VC, edit the scripts, and reassign the user-defined values according to the chart you create.
UNINSTALLING THE SMARTS INTEGRATION ADAPTOR Uninstall Instructions for Linux and Solaris Use the following steps to uninstall the Integration Adaptor for Smarts on the Linux, Windows, and Solaris environments. Step Action Command 1 Change Directory. cd to <VOYENCE_HOME>/software/Uninstall_Smarts/ 2 Enter the Uninstall command. 3 Begin the Uninstall process../uninstall Smarts Integration Module Press the Enter key. Uninstall Instructions for Windows Use the following steps to uninstall the Integration Adaptor for Smarts on the Linux, Windows, and Solaris environments. Step Action Command 1 Go to the Install/Uninstall Programs. 2 Begin the Uninstall process. 3 Complete the Uninstall process. Click Smarts Integration Module, and then click Change/Remove. Click Uninstall, and then click Done.
WHERE TO GET HELP Where to get help EMC support, product, and licensing information can be obtained as follows. Product information For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at: http://powerlink.emc.com Technical support For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account. Sales and customer service contacts For the list of EMC sales locations, please access the EMC home page at: http://emc.com/contact
INDEX A Active Synchronization, 7 Advanced Configuration, 21 AM Domain Name, 13 AM Password, 13 AM Username, 13 Auth Conf Location, 14 B Batch Device Synchronization, 6 Broker IP Address, 13 C Client Tools, 17 Configuring SMARTS for Contextual Launch, 16 Configuring the Adaptor, 11 Configuring the Integration Adaptor, 11 Configuring the Service Assurance Manager Dashboard (Web Client), 20 Configuring the Smarts Integration Adaptor, 11 Contextual Launch, 4 copyright, 2 Credential Synchronization, 4, 7 Customizing Notifications, 21 Cxn Retries, 14 Cxn Retry Interval, 14 D Default IP AM, 15 Deployment, 5 Device Change Report Client Tool, 19 Device Communication Report Client Tool, 18 Device Compliance Report Client Tool, 19 Device Synchronization, 4, 7 Discovering VoyenceControl in Smarts, 11 DS API Hostname, 14 DS API Password, 14 DS API Username, 14 E EMC Smarts IP Availability Manager 7.0, 4 EMC Smarts Service Assurance Management Suite 7.1, 4 Event Name, 21 Event Notification, 4, 7 Event Notifications, 15 Event Text, 21 H Hostname, 14 How the Integration Adaptor Operates, 6 I Installating the Smarts Integration Adaptor, 9 Installing the Contextual Launch Script for Smarts, 10 Installing the Smarts Integration Adaptor, 9 Introducing EMC Smarts integration adaptor, 4 Introduction, 4 P Password, 14 Powerlink, 23 R Recommendations for Deployment Scenarios, 8 Red Hat Enterprise Linux 4, 4 Report Advisor, 4 Restarting EMC Smarts Service Assurance Manager Server Service on Windows, 17 Run In Maintenance Window, 15 Run Upon Approval, 15 S SAM Domain Name, 13 SAM Password, 13 SAM Username, 13 SERVER-IP, 11 Severity, 21 Smarts IP AM Connection(s) Configuration, 13 Smarts SAM Connection Configuration, 13 Solaris 10, 4 Support, 23 Synchronization, 8 Synchronization Options, 15 System and Platform Requirements, 4 T table of contents, 3 U Uninstall Instructions for Linux and Solaris, 22
Uninstall Instructions for Windows, 22 UnInstalling the Smarts Integration Adaptor, 22 User-Defined Fields, 21 Username, 14 V Voyence Device Info Client Tool, 17 Voyence Device Query Client Tool, 19 Voyence Job Info Client Tool, 18 Voyence Query Client Tool, 18 VoyenceControl 4.0.1 Hot Fix 1, 4 VoyenceControl and Report Advisor - Collocated, 8 VoyenceControl and Report Advisor - Deployed Separately, 8 VoyenceControl Device Server, 15 VoyenceControl Job Scheduling, 15 VoyenceControl Network, 15 VoyenceControl Public API and DS API Connection Configurations, 14 VoyenceControl System Name, 13 VoyenceControl/Smarts Integration Adaptor, 5 W Where to get help, 23 Windows Server 2003, 4