Client Management Suite User Guide

Transcription

1 Client Management Suite User Guide Version: 3.0 Date:

2 ii MegaRAC XMS Client Management Suite User Guide Copyright Copyright Copyright American Megatrends, Inc. All rights reserved. This publication contains proprietary information protected by copyright. No part of this publication can be reproduced, transcribed, stored in a retrieval system, translated into any language or computer language, or transmitted in any form whatsoever without the prior written consent of the publisher, American Megatrends, Inc. American Megatrends, Inc. acknowledges the following trademarks: Intel is a registered trademark of the Intel Corporation. MS-DOS and Microsoft are registered trademarks of the Microsoft Corporation. Microsoft Windows is a trademark of the Microsoft Corporation. IBM, AT, VGA, PS/2, and OS/2 are registered trademarks and XT and CGA are trademarks of the International Business Machines Corporation. Other trademarks and trade names used in this document to refer to either the entities claiming the marks and names or their products. American Megatrends, Inc. disclaims any proprietary interest in trademarks and trade names other than its own.

3 MegaRAC XMS Client Management Suite User Guide Table of Contents iii Table of Contents Chapter MegaRAC XMS Client Management Suite...1 XMS Base Framework - Introduction...1 System Requirements...2 Prerequisites...2 Chapter XMS Client Management Suite Base Framework Installation...3 Chapter Getting Started Start XMS Service Stop XMS Service Login XMS Application Logout XMS Application Chapter XMS Welcome Dialog Quick Tips Shortcuts Chapter XMS GUI Layout Chapter XMS Configuration Discovery Configuration Global Authentication Manager Messaging Window Configuration Alert Configuration... 28

4 iv MegaRAC XMS Client Management Suite User Guide Table of Contents Server Configuration SSL Configuration User Configuration Language Selection Chapter XMS Tools Manageability Using Scripts XMS Reports Framework Retrieving XMS Server Events Managing Global Database Downloading XMS Logs Messaging Actions Chapter Managing License Allocate IP License Add New License Chapter Device List Operation Node Management Group Device Options Messaging Console Options Category Summaries IP Management Group Chapter About XMS View XMS Information Generate Debug Report Chapter XMS-In-Band Management (HX)... 80

5 MegaRAC XMS Client Management Suite User Guide Table of Contents v Introduction Chapter In-Band Management Configuration Managing Global Authentication Viewing In-Band Management Page Configuring Power Control Configuring Remote Desktop Adding Node by IP, Device or Manageability Configuring Monitoring Settings Configuring Health Thresholds BIOS Update Management Chapter XMS Tools Configuring Alerts Retrieving Event Log Information Manageability Using Scripts XMS Reports Framework Chapter General Information General Summary Software Inventory Hardware Inventory Statistics Chapter XMS-AMT Management (CX) Introduction Chapter XMS-AMT Management Configuration Configurations

6 vi MegaRAC XMS Client Management Suite User Guide Table of Contents Managing Global Authentication Viewing Client Management Extension Page Adding Node by IP, Device or Manageability Configuring Monitoring Settings Refreshing Data SNMP Trap Log Monitoring Chapter XMS Tools Configuring SNMP Trap Alert Retrieving SNMP Trap Log Information Manageability Using Scripts XMS Reports Framework Chapter General Information AMT General Summary Hardware Inventory Information AMT Information Baseboard Information Memory Information Processor Information System Information vpro Log Information Audit Log Information Event Log Chapter Device Configuration Configuring Alerts Configuring Network Security

7 MegaRAC XMS Client Management Suite User Guide Table of Contents vii Configuring SOL and IDE-R Configuring User Consent Chapter Tools Configuring Device Power IDE-Redirection (IDE-R) Serial Over LAN (SOL) Redirection KVM Redirection BIOS Update Management Chapter XMS-Dash Management (DX) Introduction Configurations Configuring Discovery Range Managing Global Authentication Viewing Dash Systems Management Extension Page Adding Node by IP, Device or Manageability Configuring Monitoring Settings Refreshing Data Chapter XMS Tools Retrieving Event Log Information Retrieving SNMP Trap Log Information Manageability Using Scripts XMS Reports Framework Chapter General Information General Summary Information Hardware Inventory Information

8 viii MegaRAC XMS Client Management Suite User Guide Table of Contents Baseboard Information Chassis Information Memory Information Processor Information System Information Software Inventory Event Log Chapter Device Configuration User Management Role Management BIOS Settings Chapter Tools Configuring Device Power Managing Redirection Chapter Appendix Event Logs For Base Framework For In-Band Management (HX) For AMT Management (CX) For Dash Management (DX) WOL-Wake on LAN Support Settings References Troubleshooting For Base Framework For In-Band Management (HX) For AMT Management (CX)

9 MegaRAC XMS Client Management Suite User Guide Table of Contents ix For Dash Management (DX) Technical Support Index

10 x MegaRAC XMS Client Management Suite User Guide List of Figures List of Figures Figure 1: Setup...3 Figure 2: Destination Folder...4 Figure 3: XMS Installer Notification...4 Figure 4: Installation Process...5 Figure 5: Installation process...5 Figure 6: Installation Complete...5 Figure 7: Uninstall...6 Figure 8: Windows Installer...7 Figure 9: XMS Configuration Installation...9 Figure 10: XMS Configuration Figure 11: Launch XMS Configuration Figure 12: Login Figure 13: Welcome to XMS Figure 14: XMS Layout Figure 15: Discovery Configuration Figure 16: Discovery Ranges Start and End IP Figure 17: Create New IP Figure 18: Create New IP/Prefix Figure 19: Global Authentication Manager Figure 20: Choose Manageability Type Figure 21: Configure Settings - Global User Figure 22: Messaging Window Figure 23: Alert Destinations Manager s Figure 24: Alert Destinations Manager Groups Figure 25: Add Group Figure 26: Choose Destinations Figure 27: Add Address - Add More to List... 33

11 MegaRAC XMS Client Management Suite User Guide List of Figures xi Figure 28: Add Group - Edit Group Figure 29: Group Added Figure 30: Server Settings Figure 31: Add or Edit Server Figure 32: Certificate Upload Figure 33: Key Upload Figure 34: XMS User Configuration Figure 35: Add User Figure 36: Basic LDAP Configuration Figure 37: Advanced LDAP Configuration Figure 38: Language Selection Figure 39: Script Manager Figure 40: Report Manager Figure 41: XMS Server Events Figure 42: Restart Messaging Figure 43: Messaging Console - Add/Edit Filter Figure 44: Allocate IP Licenses Figure 45: Add New License Figure 46: Add New License - Get Client Information Figure 47: Device List Layout Figure 48: Device Options Figure 49: Node List Figure 50: IP Management Figure 51: Discovered IP list Figure 52: XMS Information Figure 53: Generate Debug Report Figure 54: Global Authentication Manager Figure 55: Choose Manageability Type Figure 56: Configure Settings - Global User... 84

12 xii MegaRAC XMS Client Management Suite User Guide List of Figures Figure 57: Main - Node Management Page Figure 58: Node Manageability Figure 59: In-Band Management Page Figure 60: Power Control Figure 61: Remote Desktop Figure 62: Remote Desktop Settings Figure 63: Add Node Device or Manageability Figure 64: Monitoring Settings Figure 65: Health Threshold Figure 66: BIOS Update Figure 67: BIOS Update Management Figure 68: Image Management Figure 69: File Uploader Figure 70: Create or Edit a Schedule Figure 71: BIOS Update Scheduled Figure 72: Update History Figure 73: Configure Alerts Figure 74: XMS Server Events Figure 75: Set Filter Options Figure 76: XMS Script Manager Figure 77: Edit Code Figure 78: Script Manager Documentation Figure 79: Process List Figure 80: Service List Figure 81: Global Authentication Manager Figure 82: Choose Manageability Type Figure 83: Configure Settings - Global User Figure 84: Main - Node Management Page Figure 85: Node Manageability

13 MegaRAC XMS Client Management Suite User Guide List of Figures xiii Figure 86: Client Management Extension Page Figure 87: Add Node Device or Manageability Figure 88: Add Node by Device or Manageability Type Figure 89: Add Single Device Figure 90: Monitor Settings Figure 91: Refresh Settings Figure 92: SNMP Trap Alerts Figure 93: Add Alert Figure 94: Choose Destinations Figure 95: Add Address Figure 96: Edit Alert Figure 97: SNMP Trap Alerts Figure 98: SNMP Trap Log Figure 99: Script Editor Figure 100: Script Manager Documentation Figure 101: Launch Script Manager Figure 102: Script Manager Figure 103: Execution Arguments Figure 104: Server tab Figure 105: Multiple Device_ips Figure 106: AMT General Summary Figure 107: AMT Information Figure 108: Baseboard Information Figure 109: Memory Information Figure 110: Processor Information Figure 111: System Information Figure 112: vpro Information Figure 113: Audit Log Figure 114: Configure Policy

14 xiv MegaRAC XMS Client Management Suite User Guide List of Figures Figure 115: Event Log Figure 116: Event Alert Configuration Figure 117: Network Security Figure 118: Policy Information Figure 119: Filter Information Figure 120: Existing Filter Information Figure 121: Network Security - XMS Policies List Figure 122: Policy Manager Figure 123: Filters Figure 124: Add Filters Figure 125: Filters Figure 126: Policy Information Figure 127: Filter Information Figure 128: SOL and IDE-R Figure 129: User Consent Figure 130: Power Control Figure 131: Power Policy Figure 132: IDE-R window Figure 133: Security Warning dialog box Figure 134: Security Warning dialog box - Run Figure 135: Media Redirection Figure 136: Media device CD/DVD Drive Figure 137: Media device - Floppy Drive Figure 138: Media Redirection Drives Figure 139: Redirect Now Figure 140: Reboot target systems and redirect Figure 141: Boot To - ISO Image Figure 142: Boot To - IMG File Figure 143: Start Redirection

15 MegaRAC XMS Client Management Suite User Guide List of Figures xv Figure 144: Media Redirection - Redirected CD/DVD Figure 145: Media Redirection - Redirected Floppy Figure 146: Media Redirection - Boot To - CD Figure 147: SOL window Figure 148: Security Warning dialog box Figure 149: Security Warning dialog box - Run Figure 150: SOL Redirection window Figure 151: SOL Redirection window Figure 152: SOL Redirection - Power ON Figure 153: SOL - Redirected Media Figure 154: Set Media Redirection Options Figure 155: Media Redirection - CD/DVD Drive Figure 156: Media Redirection - Floppy Drive Figure 157: Media Redirection - Drives Figure 158: Media Redirection Reboot Figure 159: SOL Redirection - Start Session Figure 160: PuTTY window Figure 161: Bios screen Figure 162: SOL Redirection - Active status Figure 163: Redirection Figure 164: Redirection - PuTTY Figure 165: KVM Redirection Figure 166: Security Warning dialog box Figure 167: Security Warning dialog box - Run Figure 168: Intel(R) AMT KVM Figure 169: Media Redirection Figure 170: Media Redirection - CD/DVD Drive Figure 171: Media Redirection - Floppy Drive Figure 172: Media Redirection - Drives

16 xvi MegaRAC XMS Client Management Suite User Guide List of Figures Figure 173: Reset and Boot To Figure 174: Start Message Figure 175: Reset Option Figure 176: Stop Message Figure 177: Power dialog box Figure 178: Power On Figure 179: Power Off Figure 180: Boot To OS Figure 181: Boot to Bios Figure 182: Boot to Bios (Skip Password) Figure 183: Power Reset Figure 184: BIOS Setup Utility Figure 185: Bios Update Figure 186: BIOS Update Management Figure 187: Image Management Figure 188: File Uploader Figure 189: Create or Edit a Schedule Figure 190: Update History Figure 191: Update completed Figure 192: Global Authentication Manager Figure 193: Choose Manageability Type Figure 194: Configure Settings - Global User Figure 195: Main - Node Management Page Figure 196: Node Manageability Figure 197: Dash Management Extension Page Figure 198: Add Node Device or Manageability Figure 199: Add Node by Device or Manageability Type Figure 200: Add Single Device Figure 201: Monitor Settings

17 MegaRAC XMS Client Management Suite User Guide List of Figures xvii Figure 202: Refresh Settings Figure 203: XMS Server Events Figure 204: Set Filter Options Figure 205: XMS Server Events Figure 206: SNMP Trap Log Figure 207: Script Editor Figure 208: Script Manager Documentation Figure 209: General Information Figure 210: Baseboard Information Figure 211: Chassis Information Figure 212: Memory Information Figure 213: Processor Information Figure 214: System Information Figure 215: Software Inventory Figure 216: Event Log Figure 217: User Management Figure 218: Add User Figure 219: Change Password Figure 220: Role Management Figure 221: BIOS Settings Figure 222: Boot Order Figure 223: BIOS Attributes Figure 224: Power Control Figure 225: Redirection Window Figure 226: Security Warning Dialog Box Figure 227: Security Warning Dialog Box - Run Figure 228: DASH Redirection Figure 229: DASH Redirection - Media Redirection Figure 230: Text Redirection Tab

18 xviii MegaRAC XMS Client Management Suite User Guide List of Figures Figure 231: PuTTY Window Figure 232: Active Figure 233: Power Operation Figure 234: Power Redirection - Power ON Figure 235: Power Redirection-Power OFF State Figure 236: Power Operation-Power Reset Figure 237: Power Management Figure 238: Advanced Figure 239: Advanced

19 MegaRAC XMS Client Management Suite User Guide Limited Warranty xix Limited Warranty The buyer agrees that if this product proves to be defective, American Megatrends is only obligated to repair or replace this product at American Megatrends discretion according to the terms and conditions of the warranty registration card that accompanies this product. American Megatrends shall not be liable in tort or contract for any loss or damage, direct, incidental or consequential resulting from the use of this product. Please see the Warranty Registration Card shipped with this product for full warranty details. Disclaimer This manual describes the operation of the American Megatrends MegaRAC XMS Client Management Suite. Although, efforts have been made to assure the accuracy of the information contained here, American Megatrends expressly disclaims liability for any error in this information, and for damages, whether direct, indirect, special, exemplary, consequential or otherwise, that may result from such error, including but not limited to the loss of profits resulting from the use or misuse of the manual or information contained therein (even if American Megatrends has been advised of the possibility of such damages). Any questions or comments regarding this document or its contents must be addressed to American Megatrends at the address shown on the inside of the front cover. American Megatrends provides this publication as is without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability or fitness for a specific purpose. Some states do not allow disclaimer of express or implied warranties or the limitation or exclusion of liability for indirect, special, exemplary, incidental or consequential damages in certain transactions; therefore, this statement may not apply to you. In addition, you may have other rights, which vary from jurisdiction to jurisdiction. This publication could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. American Megatrends may make improvements and/or revisions in the product(s) and/or the program(s) described in this publication at any time. Requests for technical information about American Megatrends products must be made to your American Megatrends authorized reseller or marketing representative.

20 xx MegaRAC XMS Client Management Suite User Guide Acronyms and Abbreviations Acronyms and Abbreviations Acronyms Abbreviations AMT CIM CX DN DNS DX GUI HX IP LDAP OS PRN SNMP SSL TLS WSMAN XMS Active Management Technology Common Information Model AMT Management Plug-in for XMS Domain Name Domain Name Server Dash Management Plug-in for XMS Graphical User Interface In-band Management Plug-in for XMS Internet Protocol Lightweight Directory Access Protocol Operating System Purchase Reference Number Simple Network Management Protocol Secure Sockets Layer Transport Layer Security Web Services for Management extensible Management Suite

21 MegaRAC XMS Client Management Suite User Guide Convention Types xxi Convention Types Types Usage Text Text Text Text Button Names, Text Boxes, Labels Hyperlink Cross Reference Code Note Remember Mandatory field Text Refer Global Declaration Button Cancel Back Close Usage Cancel the current process and return to the previous screen Go back to the previous screen Exit from the current screen

22

23 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 1 Chapter 1 MegaRAC XMS Client Management Suite XMS Base Framework - Introduction MegaRAC XMS Client Management Suite is an extensible Management Suite that provides centralized management of systems deployed in a network. Organized as a plug-in framework, XMS Client Management Suite provides device specific management features for individual plug-ins. MegaRAC XMS Client Management Suite is offered as installable software for Windows and Linux OS. Following are the MegaRAC XMS Client Management Suite plug-ins: XMS-HX is an In-Band Management solution offered to monitor and manage systems remotely through operating systems as a pluggable component of MegaRAC XMS. H stands for Host, as the plug-in monitors and reports the health and performance of hardware and software components present in the managed systems. XMS-CX is an AMT Management solution offered to monitor and manage systems remotely through AMT enabled systems as a pluggable component of MegaRAC XMS. Using AMT, the plug-in provides complete out of band remote management of the system, even when the system is in power off state or when the operating system is not loaded. XMS-DX is a Dash Management solution that provides aggregated management of Dash enabled devices like Mobile and Desktop. DX provides Out-of-Band Remote Management facility even when the system is in powered off state or when an operating system is not loaded. XMS uses industry standard protocols and completely provide remote manageability. MegaRAC XMS provides a browser agnostic and intuitive web interface that allows an administrator to manage the devices by using any standard web browser. In addition, MegaRAC XMS also supports CIM-XML, WSMAN and SSH for remote manageability.

24 2 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite System Requirements Minimum hardware and software requirements for installing XMS are as follows: Hardware Requirements System Processor: System Memory: 2 GHZ 4 GB RAM Free Disk Space: 10 GB (May need more disk space depending on the nodes managed and the amount of history information needed) Software requirements Browser Internet Explorer 7 or later Mozilla Firefox 3.5 or later Google Chrome 5.0 or later Operating System The details of XMS installable OS are shown in a table below. S.No XMS Installable OS 1 Windows 7 Enterprise 32 bit 2 Windows 7 Enterprise 64 bit 3 Windows Server 2008 R2 Standard - 64 bit 4 Windows 7 Ultimate 32 bit 5 Windows 2012 Server 6 Windows 8 Prerequisites Refer XMS_Client Management Suite_Pre-Configuration_UserGuide for prerequisites.

25 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 3 Chapter 2 XMS Client Management Suite Base Framework Installation XMS installation includes install and uninstall actions for Windows operating system. For Windows: XMS base framework installation includes XMS In-band Management plug-in also. The HX plug-in does not require any separate installation or uninstallation unlike other XMS plug-ins. To install XMS in the system, follow the steps given below: 1. Uninstall the old version of XMS, if available. Refer the Release notes related to that version. This step is for clean installation. 2. Right click the ami.xms.client-3.x.yyyyy-win32-x86.exe and click Run as Administrator. An Extracting window appears for displaying the progress stage and then MegaRAC XMS Base Framework Setup dialog box appears as displayed in the subsequent screenshot. Figure 1: Setup 3. Click Next to continue. This action opens Destination Folder section in the same dialog box as displayed in the subsequent screenshot.

26 4 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Figure 2: Destination Folder 4. Click Next to continue installation in the default folder, (Or) click Change to choose another folder. By clicking Next button, the install options appear in the Setup dialog box. 5. Click Install button to start the installation process. Click Back to review or change the installation settings. Click Cancel to exit the wizard. A related screenshot is displayed below. Figure 3: XMS Installer Notification

27 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 5 6. Installation process is started by clicking Install button. A related screenshot is shown below. 7. Click Finish to exit the Setup Wizard. Figure 4: Installation Process 8. The subsequent screenshot displays the configuring of MegaRAC XMS Client Management Suite. Figure 5: Installation process 9. Once the installation is successfully completed, XMS Installer dialog box appears to display the successful installation. Figure 6: Installation Complete

28 6 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite To uninstall XMS in the system, follow the steps given below: Before uninstalling XMS, the user has to follow the steps given below: Close all the instances of XMS application and make sure that no files within the XMS installation folder are opened in the external editors. Stop the service from Start menu. Go to Start > All Programs > AMI > XMS > Stop Service. This is required for making a clean uninstallation. For more information on how to stop the service, see Stop XMS Service. There are two ways to uninstall XMS. They are as follows: Uninstall from Start Menu: (Recommended) In Window 7, go to Start > All Programs > AMI > XMS > Uninstall folder to uninstall XMS. (OR) In Windows 8, enter uninstall XMS in Search text box, and then click Uninstall XMS appears in the screen to uninstall the XMS. Clicking Uninstall folder displays Uninstall MegaRAC XMS Client Management Suite and Uninstall XMS icons. A related screenshot is displayed below. Figure 7: Uninstall 4. Click Uninstall MegaRAC XMS Client Management Suite icon to start uninstallation process only for Client Management Suite. Base Framework will be available in the machine. The installer will automatically uninstall only the client management suite without uninstalling Base. 5. (Or) click Uninstall XMS icon to start uninstallation process for entire XMS in the machine and removes Client Management Suite too. Wait until XMS is uninstalled completely. The installer will automatically uninstall the client management suite installed with the Base Framework installation.

29 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 7 6. A confirmation message box appears to confirm the uninstallation. Click Yes to begin the uninstall action. A related screenshot is displayed below. Figure 8: Windows Installer

30 8 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Uninstall from Control Panel: 1. Go to Start > Control Panel > Programs and Features. 2. Select MegaRAC XMS Base Framework from the list and right click on it and select uninstall. This starts the uninstallation process for entire XMS in the machine and removes Client Management Suite too. Wait until XMS is uninstalled completely. The installer will automatically uninstall the client management suite installed with the Base Framework installation. 3. (OR), select MegaRAC XMS Client Management Suite and click Uninstall to start uninstallation process only for Client Management Suite. Base Framework will be available in the machine.. The installer will automatically uninstall only the client management suite without uninstalling Base.

31 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 9 To configure XMS at the end of installation, follow the steps given below: At the end of the installation process, an XMS Configuration window appears as shown in the screenshot below. Figure 9: XMS Configuration Installation The web server ports section displays the availability of default web server ports. 1. Enter the required web server ports in the HTTP Port and HTTPS Port text fields. In HTTP Port, 80 is set as the default port during installation. In HTTPS Port, 443 is set as the default port during installation. 2. Click Check Port Availability button to check the port availability before applying the settings. If a message Port is not Available appears, then enter a different port number in the HTTP Port and HTTPS Port text fields, and check again. XMS will not launch if the selected ports are not available as the ports are used by another application. In such case, enter a different port number and check for the port availability. 3. Select the other options such as Restart Services and Launch Web UI as per the need. (This step is optional). 4. Click Apply to save the entered settings successfully. XMS Configuration dialog appears as shown in the screenshot below. The Saving Configuration process may take a few minutes to complete. XMS will get launched in a web browser, when Start Services and Launch UI Options are chosen.

32 10 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 5. Click OK to complete the installation. Figure 10: XMS Configuration

33 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 11 To configure XMS after installation, follow the steps given below: XMS configuration can be done anytime even after the installation. 1. Click Start > All Programs > AMI > XMS > XMS Configuration as shown in the screenshot below. Figure 11: Launch XMS Configuration 2. Follow the steps given above in To configure XMS at the end of installation.

34 12 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Getting Started Chapter 3 To get started with the XMS application, the user has to perform the following steps: Start the XMS service from Start menu. For more information on how to start the service, see Start XMS Service. Open a browser and type in the address bar or double click icon in the Windows desktop to open XMS login page. Login the XMS application by using default user name and password. For more information on how to log in, see Login XMS Application. Start XMS Service Before logging into the XMS application, the user has to start the service if it is not automatically started. For Windows: Go to Start > All Programs > AMI > XMS > Start XMS Service. This opens the command prompt, where it displays all the background processes and waits until the command prompt disappears.

35 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 13 Stop XMS Service Before uninstalling the XMS application, the user has to stop the services that are running. For Windows: Go to Start > All Programs > AMI > XMS > Stop XMS Service. This opens the command prompt, where it displays all the background processes. Wait until the command prompt disappears. Login XMS Application To log into the XMS application, the user has to follow the steps given below: Enter the name of the user in Name text box. The user name can be either in alphabets or in alpha numerals. Enter the user password in Password text box. The default user name and password is shown below. Field User Name Password Default admin password Default user name and password must be in lower-case characters. It is advised that once you log in, the user must change the admin password. The XMS Users can create a new user name and password to login to the XMS application. For more details, see Configuring User. Click Log In to log in the XMS application. Enable Use LDAP Authentication checkbox to login using LDAP credentials that has been configured. If an LDAP setting is not configured, a warning message The LDAP Server is not configured will be displayed. A sample Login screenshot is shown below.

36 14 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Logout XMS Application To logout of the XMS application: Figure 12: Login Click button on the top right corner of the XMS application. A confirmation message is displayed. Click Yes to log out of the XMS application or click No to return to the previous screen.

37 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 15 Chapter 4 XMS Welcome Dialog Once logged into XMS, a Welcome Dialog appears as shown in the screenshot below. Quick Tips Figure 13: Welcome to XMS The Welcome Dialog includes quick tips for the users. To view more tips, click Get another tip. To enable the Welcome Dialog at the startup of XMS, select Show this dialog at startup. The Welcome dialog can be accessed by another way; click About > Show Welcome Dialog. Shortcuts To get started, the user has to set discovery ranges and create global users for the devices. The Welcome Dialog provides shortcuts to set discovery ranges, create global users and to add IP address or the type of manageability. 1. To add a new device by the IP address or the type of manageability, click manageability. To know more about discovery ranges, refer Device Options. Add new device or

38 16 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite To set discovery ranges, click Add or edit discovery ranges. To know more about discovery ranges, refer Discovery Configuration. To configure global users for the devices, click Set global user authentication credentials. To know more about discovery ranges, refer Global Authentication Manager.

39 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 17 Chapter 5 XMS GUI Layout The following screenshot explains the layout of XMS: Breadcrumbs Node Categories List Top Banner OEM Customizable Base categories List Logout Button Database Usage Bar Built-in Categories List General Menu Bar Device List Tool Bar Device Category Summary Figure 14: XMS Layout Messaging System Window Device Details Window

40 18 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite XMS Configuration Chapter 6 XMS facilitates the user with options for configuring an application for various features according to the user needs and identifies the attributes of the product to meet the requirements of an end user. This helps the user to manage a device easily and effectively. Various feature configurations are as follows: Discovery Configuration Global Authentication Manager DNS Configuration Messaging Window Configuration Alert Configuration Server Configuration SSL Configuration XMS User Configuration Language Selection

41 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 19 Discovery Configuration Scouts the network for manageable devices and presents in a web interface. The liveliness of the devices is also monitored and presented to the end user. Discovered devices are listed in the IP Management. Discovery range is a range of IP address of devices available over intranet and internet. Range must be in the following format. Example: Start End So defining one range the user can discover maximum of 255 devices. To configure discovery range, follow the steps given below: Login the XMS application, a Welcome to XMS page appears. Click Open Discovery Settings button in the bottom left-hand side of the Welcome page to configure the discovery ranges. (Or) Click XMS Options > Configuration > Discovery Configuration. Discovery Configuration tab is selected by default in XMS Configuration screen as shown in the screenshot below.

42 20 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Figure 15: Discovery Configuration

43 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 21 To Create/Delete Discovery Ranges by Start and End IP: 1. Click New Range button to create a new blank entry for providing the IP ranges as shown in the following screenshot. Figure 16: Discovery Ranges Start and End IP Enter the IP address ranges in Start and End columns to discover the devices within the specified range to avoid unwanted device discovery. Click Save to trigger the discovery process. A Confirmation message appears, click Yes to save the discovery settings successfully or click No to return to the previous screen. Click Reload Discovery Settings, a Confirmation message appears. Click Yes to reload all the settings to the saved values or click No to return to the previous screen.

44 22 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 5. Select a required discovery range and click Delete Range button to delete a discovery range. To Create/Delete a Single IP: Click Save to commit all changes. Entries are limited to 256 addresses. 1. Click New IP button to create a new blank entry as shown in the screenshot below. Figure 17: Create New IP Enter the IP address in the IP field. Click Save to trigger the discovery process. A Confirmation message appears, click Yes to save the discovery settings successfully or click No to return to the previous screen.

45 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Click Reload Discovery Settings, a Confirmation message appears. Click Yes to reload all the settings to the saved values or click No to return to the previous screen. Select a required IP address and click Delete IP button to delete an IP address. Click Save to commit all changes. The single IP addresses may have also been added manually or created with the Add Device function. To Create/Delete Discovery Ranges by IP and Subnet Prefix: 1. Click New IP/Prefix button to create a new blank entry as shown in the screenshot below. Figure 18: Create New IP/Prefix Enter the starting IP address and Subnet Prefix in the Start IP and Subnet Prefix fields, respectively. Click Save to trigger the discovery process. A Confirmation message appears, click Yes to save the discovery settings successfully or click No to return to the previous screen.

46 24 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Click Reload Discovery Settings, a Confirmation message appears. Click Yes to reload all the settings to the saved values or click No to return to the previous screen. Select a required entry and click Delete IP/Prefix button to delete a discovery range. Click Save to commit all changes. The discovered devices in the device tree are unauthenticated devices. To authenticate these devices, the user has to select the required unauthenticated devices and provide the corresponding user credentials to identify the devices as AMT, DASH, Windows Device or Linux Device. For more information on how to authenticate, refer XMS HX, XMS CX and XMS DX. Global Authentication Manager Global Authentication Manager allows the user to configure global user accounts for all manageability types. In the Global Authentication Manager, the user can create, edit and delete a global user account depending on the manageability type. To configure global user accounts, follow the steps given below: 1. Click XMS Options > Global Authentication Manager (or) Click IP Management > Set Global Users; displays the Global Authentication Manager screen as shown in the screenshot below. Figure 19: Global Authentication Manager

47 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Select the type of manageability that has to be configured from the Manageability Type column in Step 1. A related screenshot is given below. Figure 20: Choose Manageability Type 3. Select an entry from Global User/Account Name field and click Edit button to edit a global user under Step 2. A related screenshot is given below.

48 26 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Figure 21: Configure Settings - Global User Enter the user credentials in the User Name and Password fields under Step 3. Click Save to add the global user successfully. This opens a Success pop-up. Click OK to return to the previous screen. Select an entry from Global User/Account Name field and click Delete button to delete a global user under Step 2. This opens a Success pop-up. Click OK to return to the previous screen. Click Close to return back to the Home screen.

49 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 27 Messaging Window Configuration Messaging Window provides information for various activities performed by the XMS application. Whenever the user performs some activities like system login, system logout, device discovery and so on, a message will be displayed with the timestamp in the Messaging Window. The user can also configure the output window and optimize the messaging window size according to their needs. 1. Click XMS Options > Configuration > Messaging Window to configure the messaging window as shown in the screenshot below. Figure 22: Messaging Window Choose the size of the messaging window from the Messaging Window Size on Startup section. Click Save button to save the settings for messaging window successfully.

50 28 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Alert Configuration XMS allows the user to configure various alert destinations for addresses and groups. User can configure server details also here. Therefore, if a specified threshold is reached, an alert will be sent to the configured alert destinations. Configuration Group Configuration Server Configuration Configuration In Configuration, the user can perform various configurations as follows. Add Address Edit Address Delete Address Test Address To add address: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed as shown in the following screenshot.

51 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 29 Figure 23: Alert Destinations Manager s Field Description Fields Description Address address of the recipient First Name First name of the recipient Last Name Last name of the recipient Description Brief description of the 2. By default, s tab is selected. 3. Click Add, an Add Address window is displayed. 4. Enter Address, First Name, Last Name and Description in the respective text boxes. First Name, Last Name and Description fields are optional.

52 30 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 5. Click Save to add the addresses successfully, and is displayed in the respective field columns as shown in Figure Alert Destinations Manager s. To edit address: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. 2. By default, s tab is selected. 3. Select the required address from the grid and click Edit, an Edit Address window is displayed. 4. Edit the required fields and click Save to save the changes successfully. To delete address: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. 2. By default, s tab is selected. 3. Select the required address from the grid and click Delete, a Confirmation message is displayed. 4. Click OK to delete the selected address successfully. To test address: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. 2. By default, s tab is selected. 3. Select the required address from the grid and click Test, a dialog box appears. 4. Click OK to send a test mail to the required address successfully.

53 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 31 Group Configuration In Group Configuration, the user can perform various configurations as follows. Add Group Edit Group Delete Group To add group: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. By default, s tab is selected. Click Groups tab to configure group as shown in the following screenshot. Figure 24: Alert Destinations Manager Groups 2. Click Add, an Add Group window is displayed as shown in the screenshot below.

54 32 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Figure 25: Add Group 3. Enter Group Name and Description in the respective text boxes. Description field is optional. 4. Click Edit Group Members button, a Choose Destinations... window appears to choose addresses and groups. A related screenshot is given below. Figure 26: Choose Destinations...

55 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Click Add More to List, an Add Address window appears as shown in the screenshot below. Figure 27: Add Address - Add More to List 6. Enter the address in the Address field. 7. Enter the required details in the First Name, Last Name and Description fields, which are optional. 8. Click Save to add the address in the columns of the Choose Destinations... window successfully. Click Close to return to the Choose Destinations... window. 9. Select the required checkboxes from the Add field column. The number of destinations selected is displayed in Total Selected Items. 10. Click OK to add the addresses in the columns of the Add Group window as shown in the screenshot below. Figure 28: Add Group - Edit Group

56 34 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 11. Click Save Changes, a Success message appears. 12. Click OK to add Group and recipients in the columns of the Alert Destinations Manager - Groups window successfully and a total number of groups available in the grid are displayed in Total Items as shown in the following screenshot. Field Description Figure 29: Group Added Fields Group Name Description Group Members Description Name of the group Brief description of the group # Recipients Displays an integer (number of addresses of the recipient recipients in the group)

57 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 35 To edit group: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. 2. By default, s tab is selected. Click Groups tab to configure group. 3. Select the required Group Name from the grid and click Edit, an Edit Group window is displayed. 4. Edit the required fields and click Edit Group Members button to open Choose Destinations... window. 5. Select or deselect the required or group from the Add column or click Add More to List button to add address to the group. 6. Click OK to display the changes in the columns of the Edit Group window. 7. Click Save Changes to add the changes to the columns of the Alert Destinations Manager Groups window successfully. To delete group: 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager window is displayed. By default, s tab is selected. Click Groups tab to delete group. 2. Select the required group from the grid and click Delete, a Success message is displayed. 3. Click OK to delete the selected group successfully.

58 36 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite Server Configuration Server configuration is required for setting up alerts in XMS. XMS uses SMTP protocol based alerting service. Alerts are based on the configured parameters. The parameters includes from health threshold values, SNMP Traps, to status change of the monitored process on a remote system. Whenever XMS identify a critical situation on the managed devices, it will send alerts to the configured destinations. XMS uses SMTP protocol to send alerts. It requires server service running on the local network. Basically, corporate server is used to send alerts to the configured destinations. 1. Click XMS Options > Alert Destinations, an Alert Destinations Manager dialog is displayed as shown in the following screenshot. Figure 30: Server Settings Select Server tab. Click Edit to make changes to the server details as shown in the screenshot below.

59 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite 37 Figure 31: Add or Edit Server Enter the server s IP Address or DNS name in the Server Name/ IP text box. Enter the name of the user in the User Name text box. This is optional parameter. Some servers may require user credentials to be set to send s. User name could be a valid user name to login to the given server. Enter the user password in the Password text box. This is optional parameter. Click Save Changes to save the server details successfully. The sever details will be saved in the XMS database and Alerting engine uses this configuration to send alerts.

60 38 MegaRAC XMS Client Management Suite User Guide MegaRAC XMS Client Management Suite SSL Configuration SSL means Secure Socket Layer, which is a protocol used to ensure secure transactions between web servers and browsers. The protocol uses a third party, a Certificate Authority (CA) to identify one end or both end of the transactions. SSL encrypt the segments of network connections at the Application Layer to ensure secure end-to-end transit at the Transport Layer. SSL certificate is needed for secured communications over the networks. XMS supports only.cert and.key files to be part of SSL configuration. Other formats have not been tested. To upload SSL certificate: 1. Click XMS Options > SSL to upload the SSL certificate file as shown in the screenshot below. Figure 32: Certificate Upload Click Browse to select the SSL certificate file. Click Upload to upload the SSL certificate file. Once the SSL certificate file is uploaded, Key text box is enabled. Click Browse to select the SSL key. A related screenshot is displayed below. Figure 33: Key Upload