intel server management toolkit (ismt)download.koncar-inem.hr/.../ismt_userguide_rev1.6.pdf6 intel®...

Intel ® Server Management Toolkit (ISMT) User Guide Rev 1.6

October 2015

ii Intel® Server Management Toolkit User Guide

Legal Statements

No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this

document.Intel disclaims all express and implied warranties, including without limitation, the implied warranties of

merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course

of performance, course of dealing, or usage in trade.

The products described in this document may contain design defects or errors known as errata which may cause the

product to deviate from published specifications. Current characterized errata are available on request.

All information provided here is subject to change without notice. Contact your Intel representative to obtain the

latest Intel product specifications and roadmaps.

Copies of documents which have an order number and are referenced in this document, or other Intel literature, may

be obtained by calling 1-800-548-4725, or go to: http://www.intel.com/design/literature.

Intel is a trademark of Intel Corporation in the U.S. and/or other countries.

*Other names and brands may be claimed as the property of others

Copyright © 2015 Intel Corporation. All rights reserved. Intel Corporation, 2200 Mission College Blvd., Santa Clara,

CA 95052-8119, USA.

Intel® Server Management Toolkit User Guide iii

Contents

1 Introduction ................................................................................ 6

1.1 Document Scope ........................................................................................ 6

1.2 System Requirements ................................................................................ 6

1.3 Supported Language .................................................................................. 6

1.4 Target Audience ......................................................................................... 7

1.5 Terminology .............................................................................................. 7

1.6 Features and Benefits ................................................................................. 8

1.6.1 Discovery ..................................................................................... 8

1.6.2 Provision ...................................................................................... 9

1.6.3 Inquire System Information .......................................................... 10

1.6.4 Monitor Systems ......................................................................... 10

1.6.5 Get Performance Data .................................................................. 10

1.6.6 Configure BMC and RAID .............................................................. 10

1.6.7 Chassis Identification and Power Action .......................................... 11

1.6.8 Update System Firmware ............................................................. 11

1.7 Related Documents .................................................................................. 11

1.8 Intel® Support ......................................................................................... 11

2 Get Started ................................................................................ 12

2.1 Prerequisites to Installation ....................................................................... 12

2.1.1 Prerequisites for In-Band .............................................................. 12

2.1.2 Prerequisites for Out-of-Band ........................................................ 13

2.2 Installation Steps ..................................................................................... 15

2.3 Uninstallation Steps ................................................................................. 15

2.4 Understand ISMT Structure ....................................................................... 16

2.5 Configuration Flow ................................................................................... 18

3 Configurations ........................................................................... 19

3.1 General Configuration File ......................................................................... 19

3.2 Script-Specific Configuration Files .............................................................. 22

3.2.1 ism_sensorconfig.xml .................................................................. 22

3.2.2 ism_bmcconfig.xml ...................................................................... 23

3.3 Database File .......................................................................................... 25

3.4 Network Shared Drive .............................................................................. 26

4 Feature Scripts .......................................................................... 28

4.1 General Rules .......................................................................................... 28

4.2 Usage Flow ............................................................................................. 29

4.3 Add New Hostgroup.................................................................................. 30

4.4 Delete a Host .......................................................................................... 30

4.5 Move a Host ............................................................................................ 31

4.6 Delete a Hostgroup .................................................................................. 32

4.7 List Host and Hostgroup ............................................................................ 33

4.8 Discovery ................................................................................................ 33

iv Intel® Server Management Toolkit User Guide

4.9 Provision ................................................................................................. 35

4.10 System Information Inquiry ...................................................................... 37

4.11 Monitor System Health ............................................................................. 40

4.12 Performance Data Inquiry ......................................................................... 43

4.13 BMC Configuration ................................................................................... 45

4.14 RAID Configuration .................................................................................. 47

4.15 Chassis Identification ............................................................................... 49

4.16 Power Setting Action ................................................................................ 52

4.17 System Firmware Update .......................................................................... 54

4.18 Cleanup .................................................................................................. 57

Intel® Server Management Toolkit User Guide 5

Tables

Table 1. Operating Systems and Intel ® Server Boards Supported ...................................................... 6

Table 2. Terminology ............................................................................................................................. 7

Table 3. In-Band System Configuration Requirements ...................................................................... 12

Table 4. Out-Of-Band System Configuration Requireme nts .............................................................. 13

Table 5. Directory Structure of ISMT .................................................................................................. 16

Table 6. Directory Structure of ism_scripts ....................................................................................... 16

Table 7. Categories of ISMT files ........................................................................................................ 17

Table 8. Categories of ISMT configuration files ................................................................................. 19

Table 9. Configuration Parameters of “ism_config.xm l” ................................................................... 19

Table 10. Configuration Parameters of “ism_sensorco nfig.xml” ...................................................... 23

Table 11. Configuration Parameters of “ism_bmcconfi g.xml” .......................................................... 23

Figures

Figure 1: ISMT Management Server and Managed Server s in CLI Mode. 9

Figure 2: ISMT Management Server and Managed Server s using Nagios* and NRPE. 9

Figure 3: ISMT provision feature. 9

Figure 4: Inquire managed server’s information usin g ISMT. 10

Figure 5: Update and configure managed servers usin g ISMT. 11

Figure 6. ISMT Configuration Flowchart. 18

Figure 7. The flowchart of ISMT Feature Script usag e. 29

6 Intel® Server Management Toolkit User Guide

1 Introduction

The Intel® Server Management Toolkit (ISMT) is a multi-server management tool to manage

in-band and out-of-band Intel® Server Boards and Systems in a datacenter with a simple and

easy-to-use interface. ISMT currently offers two types of management interface: (i) Command

Line (CLI) and (ii) as a Nagios* plugin to use as-is. It is an innovative tool-of-tools which

attaches with various server management utilites developed by Intel. Also, ISMT is easy-to-

use, low in maintenance, and it provides seamless integration with your Intel® Server Boards

and Systems in a datacenter. ISMT is designed to work with the following Intel® Server Boards

families:

• Intel® Server Board and System S2600WT family

• Intel® Server Board S2600KP family

• Intel® Server Board S2600TP family

• Intel® Server Board S2600CW family

1.1 Document Scope The purpose of this document is to help system/server administrators to install and use the

Intel® Server Management Toolkit (ISMT). It provides you detailed information on the features

and benefits of ISMT and how to use them. It describes the system and software

requirements, supported operating systems and platforms. This document also explains the

installation and uninstallation process.

1.2 System Requirements

Table 1. Operating Systems and Intel® Server Boards Supported

Intel® Server Boards Operating Systems Version

Intel® Server Board S2600WT family

Intel® Server Board S2600KP family

Intel® Server Board S2600TP family

Intel® Server Board S2600CW family

1. Red Hat Enterprise Linux* 6.5 and 7.0

(EM64T with IA32 compatible libraries)

2. SuSE Linux Enterprise Server* 11.3 and

12.0**

(EM64T with IA32 compatible libraries)

** Only supports command line interface, not

supporting Nagios.

Note: Refer to the release notes for known issues on installation and usage.

1.3 Supported Language User Guide is available in English only.


1.4 Target Audience

This User Guide is intended for administrators and users who will use ISMT for the

management of multiple Intel® Server Boards and Systems in a datacenter.

1.5 Terminology

Table 2. Terminology

Term Definition

BMC Baseboard Management Controller

CLI Command-Line Interface

DHCP Dynamic Host Configuration Protocol

FRU Field Replaceable Unit

IN-BAND In-band managed server refers to any system which could be SSH from

management server via normal configured network interface connection.

IPMI Intelligent Platform Management Interface. Operates independently of the

operating system (OS) and allows you to manage a system remotely, even in

the absence of the OS.

LAN Local Area Network

Management

Server

Intel® Server System where ISMT is installed. It will be acting as host server

which has network connectivity to the rest of the managed servers.

Managed Server Intel® Server System in a cluster or data center that will be managed by

Management Server.

NRPE Nagios* Remote Plugin Executor

OUT-OF-BAND Out-of-band managed server refers to any system which is configured with

valid IPMI lan channel and logon account to allow remote management via

IPMI protocol.

SDR Sensor Data Record

SEL System Event Log

SNMP Simple Network Management Protocol

SNMP-SA Intel® SNMP Subagent

SOL Serial-over-LAN


SSH Secure Shell network protocol to allow remote login in a client-server network

1.6 Features and Benefits

ISMT is designed to simplify the process of managing multiple Intel® Server Systems in a

cluster or datacenter. The following are the main features of ISMT.

• Discover Intel® Server Systems

• Provision Intel® Server Systems

• Inquire system information

• Monitor systems

• Get performance data

• Configure BMC and RAID

• Chassis Identification and Power Action

• Update system firmware

1.6.1 Discovery

Use the ISMT discovery feature to detect all Intel® Server Systems and Boards in your

datacenter with ease. Discovery feature offers the option for user to add a discovered server

into the ISMT database as a “Managed Server”. Only an ISMT managed server can use other

ISMT management features and ISMT’s Nagios* plugins. Relevant Feature Script: (section 4.8) ism_discover.pyc

Management Server

Managed Server 1 In-Band (using SSH connection)

Managed Server 2 In-Band (using SSH connection)

Managed Server 3 Out-of-Band (using BMC credentials)

In-Band or Out-of-Band LAN connections

Managed Server 4 Out-of-Band (using BMC credentials)

Command Line Interface


Figure 1: ISMT Management Server and Managed Servers in CLI Mode.

Figure 2: ISMT Management Server and Managed Servers using Nagios* and NRPE.

1.6.2 Provision

Use the ISMT Provision feature to send an ISMT-client package from Management Server to

Managed Servers for installation and configuration. The provision feature may incorporate the

ISMT-client into NRPE based on user’s choice if user has already been using Nagios-NRPE in

datacenter. Relevant Feature Script: (section 4.9) ism_provisioning.pyc

Figure 3: ISMT provision feature.

Management Server Installed with Nagios*

and NRPE

Managed Server 1 Installed with NRPE

Managed Server 2 Installed with NRPE

Managed Server 3 OOB, without NRPE

Managed Server 4 OOB, without NRPE

In-band or Out-of-Band LAN connection

Nagios*-NRPE Interface

Management Server Installed with ISMT

Managed Server 1 Install ISMT-client package locally

Package copied to Managed Server

ISMT-client

package


1.6.3 Inquire System Information

ISMT offers the ability to query system information of managed servers. If the datacenter is

already managed using Nagios-NRPE, ISMT can impose its features on the existing Nagios*

plugin and provide the user with more information about Intel® Server Systems. Relevant Feature Script: (section 4.10) ism_sysinformation.pyc

Figure 4: Query managed server’s information using ISMT.

1.6.4 Monitor Systems

ISMT is capable of monitoring the status of BMC and RAID for Managed Servers, and further

analyse this status information, including the system event logs and RAID error logs. Relevant Feature Script: (section 4.11) ism_monitoring.pyc

1.6.5 Get Performance Data

Use ISMT to collect power supply data and temperature sensor data of Managed Servers.

User may customize the sensor data to be collected through a common configuration file. Relevant Feature Script: (section 4.12) ism_getperformance.pyc,

1.6.6 Configure BMC and RAID

Use ISMT to configure BMC settings of a cluster of in-band and/or out-of-band managed

servers; and/or configure RAID settings of in-band managed servers, using a common

configuration file. Relevant Feature Script: (section 4.13) ism_bmcconfig.pyc, (section 4.14) ism_raid.pyc

Management Server Installed with ISMT

Managed Server Installed with ISMT-client package

In-Band or Out-of-Band Connections

System Information,

System Health,

Performance Data


1.6.7 Chassis Identification and Power Action

Use ISMT to control chassis identification LED and/or power action of a cluster of out-of-band

managed servers. Relevant Feature Script: (section 4.15) ism_identify.pyc , (section 4.16) ism_power.pyc

1.6.8 Update System Firmware

Use ISMT to update system firmware of all managed servers from Linux* OS environment.

The firmware which can be updated using ISMT are BIOS, BMC, ME and SDR. Relevant Feature Script: (section 4.17) ism_updsysfw.pyc

Figure 5: Update and configure managed servers using ISMT.

1.7 Related Documents

Following are the related documents for reference:

• IPMI-Intelligent Platform Management Interface Specification, 2nd Generation, v2.0

(available at intel.com)

1.8 Intel® Support

Visit http://www.intel.com/p/en_US/support/ to get the latest and most complete technical

support information.

Management Server Installed with ISMT Managed Server 1

Installed with ISMT-client package

In-Band Connection

Out-of-Band Connection

Firmware Update, RAID Config.

Managed Server 2

BMC Config. Chassis ID LED, Power Action


2 Get Started

2.1 Prerequisites to Installation

This section explains the prerequisite settings that have to be installed and configured at the

Management Server and Managed Servers prior to ISMT installation. Refer to Section 2.1.1 if

you are using In-Band managed hosts, and refer to Section 2.1.2 if you are using Out-of-

Band managed hosts.

2.1.1 Prerequisites for In-Band

The table below lists the required tools and configurations for In-Band Management Servers

and In-Band Managed Servers respectively.

Table 3. In-Band System Configuration Requirements

Management Server Managed Server

Linux* OS with full

32-bits compatible

libraries.

√(1) √(1)

Additional Python*

modules installation

i.e. Pynag, Paramiko,

PyCrypto, ECDSA and

subprocess32.

√(2)

Requires python-devel for

compilation from module

source.

Ipmitool √ √

OpenIPMI driver √(3) √(3)

Sudoers file

configurations

1) For SuSe Linux* systems, add the line below to

allow secure command execution.

Defaults secure_path="/usr/sbin:/usr/bin:/sbin:/bin"

2) If your Managed Server is managed by Nagios,

please add the following bolded lines to allow ISMT

Nagios plugins execution permission.

# Disable "ssh hostname sudo <cmd>", because it will

show the password in clear.

# You have to run "ssh -t hostname sudo <cmd>".

#

Defaults requiretty

Defaults:nagios !requiretty

……


(1) If you choose to run the ISMT Utilities from a network shared path, you need to make sure the network shared server is

equipped with the 32-bits compatible libraries to ensure successful execution of ISMT scripts locally or through an SSH

connection from the Management Server.

(2) Pynag module installation can be omitted if you do not intend to use the Nagios plugins from ISMT.

(3) ISMT scripts will start the driver service if it is not yet started.

(4) Skip this step if your Managed Server is not managed by Nagios*. ISMT Provisioning script will perform update on this

nrpe.cfg to load new ISMT plugins.

(5) Skip this if you do not intend to use the Nagiosgraph. Please refer to Nagiosgraph website for the installation package and

instructions i.e. http://sourceforge.net/projects/nagiosgraph/files/nagiosgraph/.

2.1.2 Prerequisites for Out-of-Band

The table below lists the required tools and configurations for Out-of-Band Management

Servers and Out-of-Band Managed Servers respectively.

Table 4. Out-Of-Band System Configuration Requirements

Management Server Managed Server

Linux* OS with full

32-bits compatible

libraries.

√(1)

Additional Python*

modules installation

i.e. Pynag, Paramiko,

PyCrypto, ECDSA and

subprocess32.

√(2)

Requires python-devel for compilation from

module source.

Ipmitool √

OpenIPMI driver √(3)

Out-Of-Band

Configurations

If you want to enable Nagios* for ISMT plugins,

update the managed host definition file with the

Managed Server IPMI LAN addresses.

Example:

define host {

use linux-server

alias 128.101.1.30

The systems must be pre-configured

with IPMI LAN address to allow

execution of ISMT Discovery and

Provisioning scripts.

……

……

## Same thing without a password

# %wheel ALL=(ALL) NOPASSWD: ALL

nagios ALL=(ALL) NOPASSWD: ALL

Nagios* Nagios* plugins

installation and

check_nrpe ready

Nagios* plugins installation and nrpe.cfg file ready √(4)

Nagiosgraph Add-On

installation

Nagiosgraph Add-On

installation √(5)


host_name nagios-mn03

address <IPMI LAN Address>

}

Sudoers file

configurations

1) For SuSe Linux* systems, add the line

below to allow secure command execution.

Defaults

secure_path="/usr/sbin:/usr/bin:/sbin:/bin"

2) If your Managed Server is managed by

Nagios®, please add the following bolded lines

to allow ISMT Nagios® plugins execution

permission.

# Disable "ssh hostname sudo <cmd>",

because it will show the password in clear.

# You have to run "ssh -t hostname sudo

<cmd>".

#

Defaults requiretty

Defaults:nagios !requiretty

……

……

……

## Same thing without a password

# %wheel ALL=(ALL) NOPASSWD: ALL

nagios ALL=(ALL) NOPASSWD: ALL

Nagios* installation Nagios installation ready

Nagiosgraph Add-On

installation

√(6)

(1) If you choose is to run the ISMT Utilities from a network shared path, you need to make sure the network shared server

is equipped with the 32-bits compactible libraries to ensure successful execution of ISMT scripts locally or through an SSH

connection from the Management Server.

(2) Pynag module installation can be omitted if you do not intend to use the Nagios plugins from ISMT.

(3) ISMT scripts will start the driver service if it is not yet started.

(4) Skip this step if your Managed Server is not managed by Nagios.

(5) Skip this step if your Managed Server is not managed by Nagios. ISMT Provisioning script will perform update on this

nrpe.cfg to load new ISMT plugins.

(6) Skip this if you do not intend to use the Nagiosgraph. Please refer to Nagiosgraph website for the installation package and

instructions i.e. http://sourceforge.net/projects/nagiosgraph/files/nagiosgraph/.


2.2 Installation Steps To install ISMT,

Step 1. At Management Server, copy the ISMT installer <RPM file> into the local directory

/usr/local/

Step 2. Run this shell command to install ISMT.

rpm –ivh <RPM file>

ISMT will be installed to directory /usr/local/ism/.

Step 3. After installation, The user can customize the setting of ISMT to the user’s

preferences (Refer to Section 3. Configurations).

Step 4. The user must execute the Discovery script and the Provision script before other

Feature Scripts, please refer to Section 4 Feature Scripts for detailed usage of the

scripts.

2.3 Uninstallation Steps To uninstall ISMT,

Step 1. Use ism_cleanup.pyc to uninstall ISMT-client package on all Managed Servers,

and also uninstall ISMT Nagios configuration added by ISMT on the

Management Server (if it was previously configured).

python ism_cleanup.pyc --ALL

Refer to Section 4.18 for more details.

Step 2. At Management Server, run the shell command:

rpm -e ism

Step 3. Remove the /usr/local/ism Linux folder with the shell command:

rm -rf /usr/local/ism


2.4 Understand ISMT Structure The following directory structure is created in your Management Server after installation.

ISMT is installed to the directory /usr/local/ism. Default subfolders are ism_setup,

ism_data, and ism_scripts, additional subfolders like Logfiles and Perfdata will be

generated after user configure and execute the Feature Scripts.

Table 5. Directory Structure of ISMT

/usr/local/ism

/ism_setup /ism_nagiosCfg.zip

/ismpy2_6.py

/ismpy2_7.zip

/rhel-ismutils.zip

/sles-ismutils.zip

etc

/ism_data /ism_dataBase.db

Note: ism_dataBase.db is the default

database filename provided in xml config

file. This database file will be created when

addNewGroup.pyc is executed.

/ism_fwPackage Default location for checking SFUP folders

required for performing system firmware

update.

/ism_scripts Stores all executables and configuration

files.

Refer to Table 6

/Logfiles Stores logs

/Perfdata Stores performance data

Table 6. Directory Structure of ism_scripts

Folders

1. /oem

2. /lib

3. /libssh

Files

1. bmcip_sample.txt

2. db_wrapper.pyc

3. hrs_enu.ini

4. InsISMTSvc

5. ism_addNewGroup.pyc

6. ism_bmcconfig.pyc

7. ism_bmcconfig.xml

8. ism_cleanup.pyc

9. ism_config.xml

10. ism_deleteGroup.pyc

11. ism_deleteHost.pyc

12. ism_discover.pyc

13. ism_getperformance.pyc

14. ism_identify.pyc

15. ism_listGroup.pyc

16. ism_monitoring.pyc

17. ism_moveHost.pyc

18. ism_power.pyc

19. ism_provisioning.pyc

20. ism_raid.pyc

21. ism_sysinformation.pyc

22. ism_updsysfw.pyc


23. ismt_ver.txt

24. ism_sensorconfig.xml

All ISMT configuration files, feature scripts, and setup files are located inside the folder

/usr/local/ism/ism_scripts. They can be categorized into three groups by their purposes:

Configuration Files, Feature Scripts, and Setup Files.

Configuration Files are the only ones requiring editing from the user. Feature Scripts are

executable scripts which contents should stay intact, and Setup Files are used by ISMT for

installation and setup purposes, hence user can safely ignore the files.

Table 7. Categories of ISMT files

Configuration Files Feature Scripts Setup Files

Configuration files are files which requires user to edit for ISMT configuration.

Feature Scripts are the execution script to achieve ISMT functionalities and purposes.

Setup files are files strictly used for the purpose of installation and setup of ISMT.

How to edit these files? Refer to Section 3 ISMT Configurations

How to execute these scripts? Refer to Section 4 ISMT Feature Script Usage

ism_config.xml

ism_sensorconfig.xml

ism_bmcconfig.xml

db_wrapper.pyc

ism_addNewGroup.pyc

ism_bmcconfig.pyc

ism_cleanup.pyc

ism_deleteGroup.pyc

ism_deleteHost.pyc

ism_discover.pyc

ism_getperformance.pyc

ism_identify.pyc

ism_monitoring.pyc

ism_moveHost.pyc

ism_power.pyc

ism_provisioning.pyc

ism_raid.pyc

ism_sysinformation.pyc

ism_systeminfo.pyc

ism_updsysfw.pyc

hrs_enu.ini

InsISMTSvc

bmcip_sample.txt

ism_monitor.pyc

ism_perfdata.pyc

ism_sysinfo.pyc

ism_ver

ismt_ver.txt


2.5 Configuration Flow The following flow chart shows the configuration steps for post-installation. The user can

choose whether or not to save the ISMT-client package on the managed servers. Choosing

“No” requires the user to set up a shared network repository manually (see Section 3.4);

choosing “Yes”, the ISMT-client package will be copied and send to the managed servers

when user is executing ism_provisioning.pyc.

Figure 6. ISMT Configuration Flowchart.

Nagios

CLI

DONE

NO

YES

Run Discovery and Provision Scripts

Do you want to save the

ISMT-client package on

the Managed Servers ?

DONE

DONE

Start Here

Installation

See Section 2.2

Manually install ISMT-

client package to a

Network Shared Drive

See Section 3.4

Configuration

See Section 3 (Skip Section 3.4)

Run Other Feature Scripts

Inquire System Information,

Health, Performance Data;

Update Firmware, Configure

RAID & BMC

Visit Nagios* homepage for

the Managed Servers’

information, health, and

performance data


3 Configurations

ISMT is a customizable product that allows user’s configuration to align with: user’s

definitions, system requirements and an optimal usability experience. This section explains

the configuration files and setting of ISMT in details.

ISMT has two categories of configuration files: the General Configuration Files and the Script-

Specific Configuration Files. The categories are explained in Table 8.

Table 8. Categories of ISMT configuration files

General Configuration File Script-Specific Configuration Files

By default this file refers to ism_config.xml, which is

the main configuration file for ISMT. This file is required

by all Feature Scripts and it affects the functionality of

ISMT in overall.

How to edit this file?

Refer to Section 3.1 General Configuration File

Configuration files which are used by specific Feature

Scripts only.

How to edit these files?

Refer to Section 3.2 Script-Specific Configration

Files

ism_config.xml ism_sensorconfig.xml

ism_bmcconfig.xml

3.1 General Configuration File

The default configuration file for ISMT is ism_config.xml, which is located in the directory

/usr/bin/ism/ism_scripts. After installation, the user must edit the file and provide all

required parameters before executing Feature Scripts.

Note: All parameter names, symbols, and values are case-sensitive and space-sensitive.

Please be cautious when editing the configuration files.

Table 9. Configuration Parameters of “ism_config.xml”

Parameter Name Description

ism_dataBaseLocation Default:

<ism_dataBaseLocation>/usr/bin/ism/ism_data/ism_dataBase.db</is

m_dataBaseLocation>

Description:


This parameter specifies the database filename that will be used by ISMT features

to store the managed server’s information such as IP address, login credentials,

firmware versions, etc.

ismSetupLocation Default:

<ismSetupLocation>$(homedir)/</ismSetupLocation>

This parameter specifies the directory where ISMT binaries will be installed by the

Provisioning script. ISMT binaries will be installed to the SSH user home directory.

For example, when accessing a remote RHEL Managed Server by logging in as the

user “ALEX”, ISMT binaries will be installed to /home/ALEX/ismkit/rhel/.

Note: The directories ismkit/sles or ismkit/rhel will be generated according to the

host’s OS.

If the user preference is not to install ISMT binaries on every Managed Server, but

only to a dedicated server host. Then this parameter will need to be edited to

include the network share path where the ISMT binaries had been installed.

For example:

<ismSetupLocation>/mnt/nfs_mount/</ismSetupLocation>

With this example, ISMT binaries will be obtained from the path:

/mnt/nfs_mount/ismkit/rhel, and /mnt/nfs_mount/ismkit/sles

thirdparty Default: (value is empty)

<thirdparty></thirdparty>

This parameter specifies the third party server management tool (third party tool,

TPT) that co-exists with ISMT within the network of managed servers.

This parameter determines if ISMT will provision the managed servers in such a

way that adds ISMT features as service plugins to the TPT. When the parameter is

filled, the ISMT provisioning script will automatically update the TPT’s configuration

files accordingly to support ISMT features in place.

Note: Currently the only acceptable parameter value is “nagios”. Edit this

parameter from empty string to below if the update of TPT configuration files or

the installation of new ISMT plugins are needed.

<thirdparty>nagios</thirdparty>

nagios_install_path Default:

<nagios_install_path>/usr/local/nagios/</nagios_install_path>

This parameter specifies the installation path of Nagios. It allows the ISMT

provisioning script to locate the Nagios main configuration file and plugin directory.

communitystring Default:

<communitystring>public</communitystring>

This parameter specifies the “communityname” to allow SNMP remote access to

the Intel® SNMP Subagent. The provisioning script will configure the snmpd.conf

content with this parameter to allow the Intel® SNMP Subagent to communicate

with the NET-SNMP Master Agent.

Note: This value is only needed when the <alertserver_ip> value is not empty.

alertserver_ip Default: (value is empty)

<alertserver_ip></alertserver_ip>

This parameter specifies the target machine’s IP address for all SNMP Subagent


nodes to send their alerts to. The default parameter is empty - the user may need

to update it manually. The user will be prompted to enter it during execution of

provisioning script, and the paramater will be updated.

Note: If the setup of the net-snmp package and the Intel® SNMP Subagent in the

managed server is not desired, leave this parameter empty (as default). If

prompted for entry during execution of the provisioning script, skip it by pressing

[ENTER].

mgtserver_ip Default: (value is empty)

<mgtserver_ip>[user must fill]</mgtserver_ip>

This parameter specifies the IPv4 Address of the Management Server. It is empty

by default and the user MUST provide this parameter if <thirdparty> parameter

value is ‘nagios’.

The IPv4 provided by the user will be the node that all remote managed server-

nodes in the network regard as the central ISMT system. It stores and supervises

the access of a centralized database serving every managed server-node.

ism_logsLocation Default:

<ism_logsLocation>/usr/local/ism/Logfiles/serverName</ism_logsLoc

ation>

This parameter specifies the directory where ism_monitoring.pyc can store the

System Events Log and RAID Events Log of a managed host in the management

server.

Note: ism_monitoring.pyc will replace the variable “serverName” of this parameter

with the IP Address of the managed host to create a dedicated directory for that

managed host. ALWAYS append to the parameter one occurrence of

“/serverName”.

ism_perfDataLocation Default:

<ism_perfDataLocation>/usr/local/ism/PerfData/serverName</ism_pe

rfDataLocation>

This parameter specifies the directory where ism_getperformance.pyc can store

the generated performance data of a managed host in a CSV file on management

server.

Note: ism_getperformance.pyc will replace the variable “serverName” of this

parameter with the IP Address of the managed host to create a dedicated directory

for that managed host. ALWAYS append to the parameter one occurrence of

“/serverName”.

defaultHealthyTimeStamp Default:

<defaultHealthyTimeStamp>04/01/2015-01:01:00AM</def

aultHealthyTimeStamp>

This parameter specifies the first point-in-time where system health can be

assessed. The ISMT regards this parameter as the retrospective time-of-reference

for which system’s health has became important. System health status before this

time-of-reference will be ignored in data analysis.

Note: The format is dd/mm/yyyy-HH:MM:SSZZ; ZZ is either “AM” or “PM” and

time is in 12-hour format.

ism_fwPkgLocation Default:

<ism_fwPkgLocation>/usr/local/ism/ism_fwPackage/<ism_fwPkgLocat


ion>

This parameter specifies the default path SFUP package will be unzipped to

perform System Firmware Update task.

If the user preference to use network share path, then specify the network share

location where the SFUP package is unzipped.

For example:

<ism_fwPkgLocation>/mnt/nfs_mount/ism_fwPackage/</ism_

fwPkgLocation >

<S2600WT>

<S2600KP>

<S2600TP>

<S2600CW>

Default:

<S2600WT>S2600WT_SFUP_BIOSR01_01_0008_ME030007154_BMC01187601_

FRUSDR106</S2600WT>

<S2600KP>S2600KP_SFUP_BIOS01010008_ME030007154_BMC01187601_FRUS

DR104</S2600KP>

<S2600TP>S2600TP_SFUP_BIOS01010008_ME030007154_BMC01187601_FRUS

DR104</S2600TP>

<S2600CW>S2600CW_SFUP_BIOS01011008_ME030007154_BMC01187601_FRU

SDR107</S2600CW>

These parameters specify the SFUP package name for four different platform

systems. These parameters are used by ism_updsysfw. User needs to specify the

latest SFUP package name to use for updating system firmware. If user only have

<S2600WT> systems, then please remove the other three parameters from

ism_config.xml. Latest SFUP package can be downloaded from Intel website.

<S2600WT> is for product ID : S2600WT, S2600WT2 and S2600WTT

<S2600KP> is for product ID : S2600KP, S2600KPF

<S2600TP> is for product ID : S2600TP, S2600TPF

<S2600CW> is for product ID: S2600CW

3.2 Script-Specific Configuration Files

Script-specific configuration files are configuration files which are required by, and applicable

to certain Feature Scripts only. The files determine the behavior of the corresponding Feature

Scripts. User may customize these files to the user’s preferences, or use the default values.

Note: All parameter names, symbols, and values are case- and space-sensitive, please be

cautious when editing the configuration files.

3.2.1 ism_sensorconfig.xml


Use by feature script: ism_getperformance.pyc

Default path: /usr/local/ism/ism_scripts/ism_sensorconfig.xml

Table 10. Configuration Parameters of “ism_sensorconfig.xml”


<sensor_name> The contents specify the power and temperature sensors to be queried in

ism_getperformance script.

The file has entries of the format:

<sensor_name> yes | no </sensor_name>

where “sensor_name” refers to the IPMI sensor name. “yes | no” is the query

choice, sensors marked with “yes” will be queried and sensors marked with “no”

will be ignored.

The default script has a list of sensors optimized for getperformance script’s usage,

users may edit it to add or remove sensor entries.

Note: Users shall not add additional sensor names that are not valid IPMITool

Sensor Data Record (SDR) sensors. Invalid sensors might not return a value.

3.2.2 ism_bmcconfig.xml

Use by feature script: ism_bmcconfig.pyc

Default path: /usr/local/ism/ism_scripts/ism_bmcconfig.xml

Table 11. Configuration Parameters of “ism_bmcconfig.xml”


bmcDefaultUserName Default:

<bmcDefaultUserName>ISMUser</bmcDefaultUserName>

This parameter specifies the BMC username used to create a new BMC user to

BMC user list. This parameter will be overwritten if user specifically provided

new BMC login credentials as an in-line argument [-b username/password]

while executing the script.

BMC_user_account Default:

< BMC_user_account ></ BMC_user_account >

This parameter specifies the BMC USER ID if user would like to create a new

BMC user into BMC user list. Default value is empty. The value allowed for BMC

User ID is in range 4-15.

LAN_failover Default:

<LAN_failover>enable | disable</LAN_failover>

This parameter is used to enable the LAN failover feature. If it is set to “disable",


then it will disable the LAN failover feature. Lan Fail Over only can be set in

LAN Channel 1. Once lan failover is set to enable, other BMC channel cannot be

edited except channel 1.

IP_source Default:

<IP_source>STATIC | DHCP | <empty></IP_source>

This parameter is used to set the IP source for BMC IP. Only options are

“STATIC” or “DHCP” or “<empty>”. If it is STATIC, user needs to provide of

BMC IP assigned for all the HOST IP in file specified in <Static_filename>. This

is only for INBAND Host IP to configure BMC IP. If <empty> , user leave it

blank, then it will not perform BMC IP configuration.

Default_gateway_IP Default:

<Default_gateway_IP>192.168.1.96</Default_gateway_IP>

This parameter is used to set the default gateway ip for the bmc ip setup.

subnet_mask Default:

<subnet_mask>255.255.255.0</subnet_mask>

This parameter is used to set the subnet mask for the bmc ip setup.

Static_filename Default:

<Static_filename>bmcip_sample.txt</Static_filename>

This parameter is used to configure static bmc ip. User may write a list of host

ip with the BMC IP to be assigned. The format is “192.168.1.1:128.101.1.1”.

Host IP is on the left side while BMC IP to set is on the right side after the colon.

Each host must be in new line. Notes: Please make sure no duplicate of IP in

the file.

Serial_over_LAN Default:

<serial_over_LAN>enable | disable | <empty></serial_over_LAN>

This parameter is used to enable serial over lan setting. If set to “disable”, it

will disable serial over lan. If it is <empty>, then it will not perform this action.

LAN_alerting Default:

<LAN_alerting>enable | disable</ LAN_alerting >

This parameter is used to enable the LAN alerting. If set to “disable”, it will not

enable LAN alerting. However, it will not disable the LAN alerting if it had

previously set to enable.

LAN_alerting_dest_1_ty

pe

Default:

<LAN_alerting_dest_1_type>SNMP</LAN_alerting_dest_1_type>

This parameter specifies the LAN alerting type for destination Note: Only

“SNMP” is supported.

LAN_alerting_dest_1_ale

rt_IP

Default:

<LAN_alerting_dest_1_alert_IP>192.168.1.1</LAN_alerting_dest_1

_alert_IP>

This parameter specifies the target machine IP address for SNMP to send out

alert trap message.



rt_MAC

Default:

<LAN_alerting_dest_1_alert_MAC>00-00-00-00-00-

00</LAN_alerting_dest_1_alert_MAC>

This parameter specifies the target machine MAC address for SNMP to send out

alert trap message.

LAN_alerting_dest_2_ty

pe

Default:

<LAN_alerting_dest_2_type>SNMP</LAN_alerting_dest_2_type>

This parameter specifies the LAN alerting type for destination Note: Only

“SNMP” is supported.


rt_IP

Default:

<LAN_alerting_dest_2_alert_IP>192.168.1.1</LAN_alerting_dest_2

_alert_IP>

This parameter specifies the target machine IP address for SNMP to send out

alert trap message.


rt_MAC

Default:

<LAN_alerting_dest_2_alert_MAC>00-00-00-00-00-

00</LAN_alerting_dest_2_alert_MAC>

This parameter specifies the target machine MAC address for SNMP to send out

alert trap message.

3.3 Database File

ISMT uses a database file in .db format to store the information of the managed servers. The

database file will be created when the user executes the Feature Script

ism_addNewGroup.pyc. The name of the database file is provided by the general

configuration file ism_config.xml, and the default file name is ism_dataBase.db.

Default directory and filename:

/usr/local/ism/ism_data/ism_dataBase.db

If user wishes to use different filename, the change can be made by editing the parameter

<ism_dataBaseLocation> in ism_config.xml -- changing [ism_dataBase].db to

[new_name].db. The dataBase file must be placed in the directory /ism_data.

For further details of editing ism_config.xml, please refer to Section 3.1 General Configuration

File


3.4 Network Shared Drive ISMT offers the versatility for the user to install ISMT-client package to the Managed Server

from the installer package located in a network shared drive on the Management Server’s disc

space, instead of saving the installer package in the managed server’s own disc space, thus

saving the disc space of the Managed Server.

To set up this feature, the user must complete the following steps.

Step 1. Create a shared directory on Management Server’s network with accessibility from

all Managed Servers. The shared directory will act as the centralised installer

repository.

Shared directory path = [network shared]

Example: Shared directory path = /mount/ismt_repo/

Step 2. Change the following parameter within the general configuration file (default file

is ism_config.xml):

From

<ismSetupLocation>$(homedir)</ismSetupLocation>

To

<ismSetupLocation>[network shared]</ismSetupLocation>

For details on editing this file, please refer to Section 3.1 General Configuration File

Step 3. In the network shared directory, create two subdirectories, /ismkit/rhel and

/ismkit/sles, to cater for Managed Servers with (i) Red Hat Linux* OS and (ii)

SuSE Linux* OS.

Shell Commands:

(i) mkdir -p [network shared]/ismkit/rhel/snmpsa

(ii) mkdir -p [network shared]/ismkit/sles/snmpsa

Step 4. Unzip the rhel-ismutils.zip and sles-ismutils.zip installers from directory

/usr/local/ism/ism_setup to the newly-created installer repositories

respectively.

Shell Commands:

(i) unzip -d [network shared]/ismkit/rhel /usr/local/ism/ism_setup/rhel-

ismutils.zip

(ii) unzip -d [network shared]/ismkit/sles usr/local/ism/ism_setup/sles-

ismutils.zip


Step 5. Unzip the rhel-snmpsa7.zip and sles-snmpsa7.zip installers from directory

/usr/local/ism/ism_setup to the network shared’s installer repositories

respectively:

(i) unzip -d [network shared]/ismkit/rhel/snmpsa

/usr/local/ism/ism_setup/rhel-snmpsa7.zip

(ii) unzip -d [network shared]/ismkit/sles/snmpsa

usr/local/ism/ism_setup/sles-snmpsa7.zip


4 Feature Scripts

The Feature Scripts are the main engines of ISMT. The power of ISMT is achieved through

customized execution of the Feature Scripts. This section explains the ways to execute ISMT

Feature Scripts, and the objectives the user can accomplish by using them.

4.1 General Rules

1. To display a helpful guide on how to execute each script, you can enter the shell

command:

python <feature script>.pyc

Examples: python ism_addNewGroup.pyc

2. If the user is using the default general configuration file ism_config.xml, the user

may provide it as argument [–x] after the Feature Script’s name. However, this is

optional.

python <Feature Script>.pyc -x ism_config.xml

If user wants to use a configuration file other than ism_config.xml, the user must

provide the filename as an argument –x.

python <Feature Script>.pyc -x <config_filename>.xml

3. It is recommended that all servers in the same network managed by ISMT are

synchronous in time. A Management Server and multiple Managed Servers with

different time settings may cause chronological confusion and conflict when the data

are collected and analyzed.

4. Terminology used in this section

managed server, host, member*

Refers to the server managed by a central Management Server on same network and having at least one accessible IPv4 Address

management server Refers to the server where ISMT binaries reside and are executed from. It also stores the database file.

hostgroup, group Refers to the grouping of host(s) under a group name. A group’s entities are called “members” or “hosts” interchangeably. Members* are managed servers in a group.

Feature Script Refers to any Python-based script, which represents a ISMT feature, specified from Section 4.3 to 4.18


4.2 Usage Flow

New installation requires user to execute discovery and provision for once to set up the

environment and database. ISMT has the capability to discover, provision, and manage new

Intel® Server Systems connected to the network in datacenter while maintaining the existing

database.

The following flowchart shows the recommended sequence of executing Feature Scripts. The

user is advised to follow this flow sequence.

Figure 7. The flowchart of ISMT Feature Script usage.

First-Time Installation

New Intel® Server System added

to existing network ?

Add to existing group?

If yes, skip this step

If no, create new group

Discover the new server and add

it to group

Provision the new server

Configurations

Section 3 Configurations

ism_addNewGroup.pyc

Refer Section 4.3

ism_discover.pyc

Refer Section 4.8

ism_provisioning.pyc

Refer Section 4.9

User can now execute other Feature Scripts


4.3 Add New Hostgroup

The execution of this script creates a hostgroup in the database and configuration files. The

hostgroup will accommodate the hosts added to it as “members”. A hostgroup must be

created before executing the Discovery script, and each managed server must be associated

with a hostgroup.

Shell Command:

python ism_addNewGroup.pyc [-x xml config filename] [-g groupname]

[-x xml config filename] The Filename for the general configuration file

located in the same directory as the Feature

Scripts. i.e. /usr/local/ism/ism_scripts/

This argument is optional; if not provided, the

default general configuration file ism_config.xml

will be used.

[-g groupname] A valid groupname previously added to the ISMT

database. [-I IP address] will be added as its

member.

Examples of Usage:

python ism_addNewGroup.pyc –x ism_config.xml -g IntelGroupAlpha

python ism_addNewGroup.pyc –x ism_config.xml -g IntelGroupBeta

4.4 Delete a Host

The execution of this script deletes a previously-added host (managed server) from the

database.

Shell Command:

python ism_deleteHost.pyc [-x xml config filename] [-I IP Address]







will be used.

[-I IP address] A valid IP address previously added to the ISMT

database, it will be removed from the database.

Examples of Usage:

python ism_deleteHostFromGroup.pyc –x ism_config.xml -i 192.168.1.15

python ism_deleteHostFromGroup.pyc -i 192.168.1.20

4.5 Move a Host

The execution of this script changes the residing hostgroup of a host. The host will be removed

from its residing “source group” and added to the “destination group”. For the script to take

effect, the host must exist as a member of the “source group”, and the “destination group”

must already has been created.

Shell Command:

python ism_moveHost.pyc [-x xml config filename] [-I IP address] [-S source

groupname] [-D destination groupname]






will be used.

[-I IP address] A valid IP address previously added to the ISMT

database, it will be moved from the member-list


of [-S source groupname] to the member-list of [-

D destination groupname].

[-S source groupname] A valid groupname previously added to the ISMT

database. [-I IP address] will be removed from its

member list.

[-D destination

groupname]

A valid groupname previously added to the ISMT

database. [-I IP address] will be added to its

member list.

Examples of Usage:

python ism_moveHost.pyc –x ism_config.xml -i 192.168.1.15 –S IntelGroupAlpha –D IntelGroupBeta

python ism_moveHost.pyc –x ism_config.xml -i 192.168.1.20 –S IntelGroupBeta –D IntelGroupAlpha

4.6 Delete a Hostgroup

The execution of this script deletes an existing group. This script requires the group to already

exist in the database and configuration files. All previously-added hosts that are members of

the hostgroup will be removed from database after script execution.

Shell Command:

python ism_deleteGroup.pyc [-x xml config filename] [-g groupname]






will be used.

[-g groupname] A valid groupname previously added to the ISMT

database. It will be removed from ISMT database

and third-party tool configuration file.

Examples of Usage:


python ism_deleteGroup.pyc –x ism_config.xml -g IntelGroupAlpha

python ism_deleteGroup.pyc –x ism_config.xml -g IntelGroupBeta

4.7 List Host and Hostgroup

The execution of this script lists the host IP and groups in database. The user can choose to

search by giving a host IP, or a giving a group’s name, or simply list everything by giving the

correct argument.

Shell Command:

python ism_listGroups.pyc [-x xml config filename] [-i IP Address] [-g groupname]






will be used.

[-i IP address] Lists the affiliated group of the IP address.

[-g groupname] Lists the members (host IP address) of the

groupname.

[-ALL] Lists all the groups and corresponding members in

database.

Examples of Usage:

python ism_listGroups.pyc –x ism_config.xml -ALL

python ism_listGroups.pyc –x ism_config.xml –g IntelGroupBeta

4.8 Discovery

The execution of this script discovers Intel® Server Systems in datacenter’s network from a

range of IPv4 provided by user. For the discovery to be successful, user must provide either

one of the SSH or BMC login credentials or both. The argument [-a groupname] is used to

add the discovered server to a database’s hostgroup for easier management. Intel® Server


Systems which have been discovered and added to ISMT database will thus known as

“Managed Servers”.

Shell Command:

python ism_discover.pyc [-x xml config filename] [–I IP address] [–c

username/password] [-b username/password] [–a groupname] [--netshare]






will be used.

[-i IP address] A valid IP address (in dot-decimal notation) of a

single server, or a valid IP address range

represented in the format of start IP address and

the end IP address separated by a dash (‘-’)

character; for example: 192.168.1.1-

192.168.1.30, or several valid IP address entries

(single, range or combination of both styles)

separated by comma(‘,’) character; for example:

-I 192.168.2.45,192.168.2.20-192.168.2.30,

192.168.3.20-192.168.3.30,192.168.4.11

[–c username/password] Valid pair of SSH login with username and

password separated by forward slash(‘/’)

character to discover remote server(s) within the

network. The username is not limited to ‘root’ user

but include other trusted users who are already in

sudoer list with administrative access privileges.

This argument could be omitted if all the systems

for discovery are pre-configured with BMC settings

for out-of-band access. Refer to the -b optional

flag for the out-of-band system discovery

requirements.

[-b username/password] Valid pair of BMC username and password. This

entry is only useful if the servers in network have

been pre-configured with BMC settings that


allow IPMI lan channel access from a management

server.

This argument could be used along with the [-c

username/password] flag if user intends to do a

discovery for EPSD servers mixed network

environment of in-band systems and out-of-

systems.

[-a groupname] Groupname is used for adding the discovered

EPSD server(s) in the ISMT database. It must be

a valid groupname that was already created in the

ISMT database.

This argument is optional; if not provided,

discovered server(s) will not be added to the ISMT

database.

[--netshare] Provide this flag if the Intel® Utilities binaries are

installed only at a network shared path. Discovery

will check if the remote server(s) is mounted to

the network share path.

Examples of Usage:

python ism_discover.pyc –I 192.168.1.15 –c root/secretpassword

python ism_discover.pyc –x ism_config.xml –I 192.168.1.15 –c root/secretpassword –a epsd

python ism_discover.pyc –I 192.168.1.20 –c root/secretpassword –-netshare

python ism_discover.pyc –I 192.168.1.15-192.168.1.100 –c alan/alansecretpassword –a epsd

python ism_discover.pyc –I 192.168.1.15-192.168.1.100,192.168.3.20-192.168.3.50 –b test2/test2secret

python ism_discover.pyc –I 192.168.1.15-192.168.1.100,192.168.3.20-192.168.3.50 –b test2/test2secret –a

epsd

python ism_discover.pyc –I 192.168.1.15-192.168.1.100,192.168.3.20-192.168.3.50 -c root/secretpassword –b

test2/test2secret –a epsd

4.9 Provision

The execution of this script installs the ISMT-client package on the managed servers, so that

subsequent feature scripts able to access the installed binaries to perform the feature tasks

such as execution of storcli for raid configuration, execution of flashupdt to do firmware

upgrade or downgrade and execution of syscfg for system information retrieving. If user do

not wish every managed server get installed with the ISMT-client package, user can opt to

install the ISMT-client package manually (refer section 3.4), and provided the [--netshare]


argument during provision script run.

For integration with Nagios* Management Tools, provision will help to update the Nagios*

configuration path with additional configuration files. The files are ismcommands.cfg, ism-

inband.cfg and ism-outband.cfg respectively.

If managed server was discovered earlier is a in-band Nagios* ready, provisioning will install

the ISMT nagios plugins to the managed server’s install path, such as

<nagios_install_path>/libexec/ISM.

If there is out-of-band Nagios* managed server for provision, ISMT nagios plugins will be

installed locally at the Management Server (which is the Nagios* Management Server), at the

Nagios install path defined in XML configuration file, i.e

<nagios_install_path>/libexec/ISM.

Shell Command:

python ism_provisioning.pyc [-x xml config filename] {--ALL | –I IP address | -g

groupname} [--netshare]






will be used.

--ALL When this flag is provided, all servers in ISMT

database will be accessed via SSH for provisioning

if they are in-band servers. For out-of-band

servers in the ISMT database, provisioning on

those servers will only be limited to set up of the

Nagios* configuration files to load ISMT service

plugins by Nagios Management Server.

[-i IP address] A valid IP address previously added in ISMT

database for a server during discovery. If a group

of servers in ISMT database are required for

provisioning, use [–g groupname] argument

option. This [-I IP address] is only meant for


representation of a single server which was added

previously in ISMT database.

[-g groupname] A valid groupname previously added in ISMT

database, with at least one server associated to

the group.

[--netshare] Provide this flag if the binaries files of the software

utilities for Intel® Server Systems are to be

installed at a network shared path. Provisioning

will only verify managed server has access to the

mounted network share path, but will not install

the utilities on the network share path.

Examples of Usage:

python ism_provisioning.pyc –i 192.168.1.15

python ism_provisioning.pyc -x ism_confignew.xml –i 192.168.1.15

python ism_provisioning.pyc –g IBSERVER

python ism_provisioning.pyc -g OBSERVER

python ism_provisioning.pyc -g IBSERVER –netshare

4.10 System Information Inquiry

The execution of this script checks and displays the inquired information of the referred

managed systems. The time to execute is controlled by argument “NOW” and “RunAtTime”;

the amount of information is controlled by “InfoALL” (query everything) or query one in “BIOS

/ ME / BMC / SDR / RMM / POWER / NumSENSOR”

Shell Command:

python ism_sysinformation.pyc [-x xml config filename] {--NOW | --RunAtTime | --

LOOP} {--ALL | –i IP address | -g groupname} {--InfoALL | --BIOS | --ME | --BMC | -

-SDR | --RMM | --POWER | --NumSENSOR}







will be used.

--NOW Execute the script at the current system time.

This argument and [--RunAtTime or --LOOP]

argument has to be used exclusively; script

will accept only one per instance.

--RunAtTime

Execute the script at the user’s set time. This

option requires user to enter timer’s duration.

If this argument and [--NOW or --LOOP] are not

provided, script will execute at the current system

time. This argument and the [--NOW or --

LOOP] argument has to be used exclusively;

script will accept only one per instance.

--LOOP

Execute the script at the user’s set time with

repetitive mode.

1. Run at execution time everyday

2. Run at execution time same day every

week

--ALL When this flag is provided, all servers in the ISMT

database will be accessed via SSH for queries if

they are in-band servers that could be connected

with SSH logon credential stored in database;

alternatively, they may be accessed via the BMC

LAN for queries if they are out-of-band servers

that could be connected with BMC logon credential

stored in database

[-i IP address] A valid IP address previously added in the ISMT


of servers in the ISMT database are required for

querying the system information, use the [–g

groupname] argument option.


[-g groupname] A valid groupname previously added in the ISMT

database, with at least one server associated with

the group.

--InfoALL Script returns the versions of BIOS, BMC, SDR,

status of RMM, Power; and the number of sensor

of inquired system(s).

--BIOS Script returns the BIOS version of the inquired

system(s).

Returns: <BIOS version>

--ME Script returns the ME version of the inquired

system(s).

Returns: <ME version>

--BMC Script returns the BMC version of the inquired

system(s).

Returns: <BMC version>

--SDR Script returns the SDR version of the inquired

system(s).

Returns: <SDR version>

--RMM Script returns the RMM status of the inquired

system(s).

Returns: ‘RMM Not Present’, ‘RMM3 Present’,

‘RMM4 Lite Present’

--POWER Script returns the Power status of the inquired

system(s).

Returns: ‘Power ON’ or ‘Power OFF’

--NumSENSOR Script returns the number of sensors of the


inquired system(s).

Returns: <Number of sensors>

Examples of Usage:

python ism_sysinformation.pyc -x ism_config.xml --NOW –i 192.168.1.15 --SDR

python ism _sysinformation.pyc --NOW –i 192.168.1.15 --InfoALL

python ism _sysinformation.pyc --RunAtTime –g IBSERVERS –RMM

python ism _sysinformation.pyc --RunAtTime –-ALL --BMC

python ism _sysinformation.pyc -x ism_config.xml --NOW -g OOBSERVERS –NumSENSOR

4.11 Monitor System Health

The execution of this script checks and displays the health status of the referred systems. The

time to execute is controlled by argument “NOW” and “RunAtTime”; the amount of information

is controlled by “BMC” and “RAID”. By standard procedure, the script will check the System

Event Log (SEL) if the system is found to be rebooted even it is currently healthy; use the

“RESET” to skip the SEL collection as long as the system is currently healthy.

Shell Command:

python ism_monitoring.pyc [-x xml config filename] {--NOW | --RunAtTime | --LOOP

} {--ALL | –i IP address | -g groupname} { --BMC | --RAID} --RESET






will be used.



argument has to be used exclusively; script will

accept only one per instance.

--RunAtTime






time. This argument and the [--NOW or --LOOP]



--LOOP


repetitive mode.



week




with SSH logon credential stored in database;

alternatively, they may be accessed via BMC LAN

for queries if they are out-of-band servers which

could be connected with BMC logon credentials

stored in the database.




querying the system information, use the [–g


[-g groupname] A valid groupname previously added in the ISMT

database, with at least one server associated with

the group.

--BMC When this flag is provided, the script will not check

for the RAID contribution to health. The script will

check the BMC Status LED and will return the state

of inquired system(s).

This argument and the --RAID argument are

optional; if both are not provided, the script will

check both BMC and RAID contribution to health.

Example A:

BMC Health Status :Critical (04)


Get SEL Log :Successful

Log at:/usr/local/ism/Logfiles/172.21.133.36/selLog.txt

System Events occurred since Last Healthy Time:

Critical :0

Warning :416

Informational :3032

--RAID When this flag is provided, the script will not check

for the BMC contribution to health. The script will

check the RAID log and return the overall disk

health report of inquired system(3).

This argument and --BMC argument are


check both BMC and RAID contribution to health.

Example A:

RAID Health Status :Healthy

Get RAID Log :Successful

Log at:/usr/local/ism/Logfiles/172.21.133.36/raidLog.txt

Example B:

RAID Health Status :Unhealthy

Get RAID Log :Successful

Log at:/usr/local/ism/Logfiles/172.21.133.36/raidLog.txt

RAID Events detected:

Failed :0

Critical :0

Offline :2

Degraded :0

--RESET When this flag is provided, the script will do a

forced reset of the host’s healthy timestamp if it’s

healthy, i.e. the script will not proceed to get the

System Event Log (SEL). However, if the host is

unhealthy, the script will proceed with standard

procedure.

This argument is optional

Examples of Usage:

python ism_monitoring.pyc –i 192.168.1.15 –NOW

python ism_monitoring.pyc –x ism_config1.xml –g INBAND –RunAtTime


python ism_monitoring.pyc --ALL –NOW --BMC

python ism_monitoring.pyc --ALL –NOW --RAID

4.12 Performance Data Inquiry

The execution of the script checks and displays the performance data of the referred system.

The performance data is defined as the readings of the system’s power supply sensors and

temperature sensors. The sensor must be listed in the script-specific configuration file

ism_sensorconfig.xml.

Shell Command:

python ism_getperformance.pyc [-x xml config filename] {--NOW | --RunAtTime | --

LOOP } {--ALL | –i IP address | -g groupname} { --POWER | --THERMAL}






will be used.





--RunAtTime





time. This argument and the [--NOW or --LOOP]



--LOOP


repetitive mode.




week




with SSH logon credential stored in the database;

alternatively, they may be accessed via BMC LAN

for queries if they are out-of-band servers that

could be connected with BMC logon credential

stored in database.

[-i IP address] A valid IP address previously added to the ISMT



querying the system information, use [–g




the group.

--POWER When this flag is provided, the script will check the

reading of power sensors of inquired system(s)

stated in [--ALL] or [ –i IP address ] or [ -g

groupname], and print the readings.

This argument and --THERMAL argument are

optional; if both are not provided, script will

check sensors from both categories.

--THERMAL When this flag is provided, the script will check the

reading of temperature sensors of inquired

system(s), and print the readings.

This argument and --POWER argument are


check sensors from both categories.

Examples of Usage:

python ism_getperformance.pyc –i 192.168.1.15 –NOW

python ism_getperformance.pyc –x ism_config1.xml –g INBAND –RunAtTime


python ism_getperformance.pyc --ALL –NOW --THERMAL

python ism_getperformance.pyc --ALL –NOW –POWER

4.13 BMC Configuration

The execution of this script updates the BMC configuration of the managed servers to settings

written in ism_bmcconfig.xml. The features that it can be configured through this script are

Lan Fail Over, Serial Over Lan, Set BMC IP, Set BMC User and Set SNMP alert.

Shell Command

python ism_bmcconfig.pyc [-x xml config filename] [--ALL | –i IP address | -g

groupname] [-b username/password] [-l LAN1|LAN2|LAN3] [--nextboot=<bootdev>] --

persistent






will be used.


database will be accessed for bmc configuration.




bmc configuration, use [–g groupname] argument

option. This [-i IP address] is only meant for


previously in the ISMT database.

[-g groupname] A valid groupname previously added to ISMT


the group.


[-b username/password] A pair of BMC user and password needed by bmc

configuration to add new bmc user.

This argument could be omitted if no value

assigned to <BMC_User_Account> in

ism_bmcconfig.xml as no new user will be added

to bmc configuration

[-l LAN1|LAN2|LAN3] IPMI lan channel for use to setup the BMC lan

channel settings.

This argument is optional; if not provided,

script will assume LAN1 for the setup.

[--nextboot=<bootdev>] Change next boot device. Supported Inputs are:-

none : Do not change boot device order

pxe : Force PXE boot

disk : Force boot from default Hard-drive

safe : Force boot from default Hard-drive,

request Safe Mode

diag : Force boot from Diagnostic Partition

cdrom : Force boot from CD/DVD

bios : Force boot into BIOS Setup

floppy: Force boot from Floppy/primary

removable media

[--persistent] Change next boot with option persistent

Examples of Usage:

python ism_bmcconfig.pyc –i 192.168.1.15

python ism_bmcconfig.pyc –g Inband

python ism_bmcconfig.pyc –i 192.168.1.15 –l LAN1

python ism_bmcconfig.pyc –g Inband

python ism_bmcconfig.pyc –g Inband –b ISMUser/ISMUser

python ism_bmcconfig.pyc --ALL –b ISMUser/ISMUser

python ism_bmcconfig.pyc –g Inband –b ISMUser/ISMUser –nextboot=disk –persistent


4.14 RAID Configuration

ISMT provides you with a convenient interface for RAID configuration that can be re-applied

to a group of managed servers with similar RAID hardware setup. Currently, only LSI

MegaRAID*, Intel® Integrated RAID modules, and Intel® ESRT2 (LSI*) controller are

supported. Intel® RSTe software RAID is not supported.

When multiple RAID controllers are available in the server system, script will show a list of all

available RAID cards. The user may choose the detected RAID controllers display on console

to proceed set up a new RAID array. Script will display the available physical hard disks which

is at “Unconfigured Good” status or still have remaining disk space to assist user in RAID

array setup.

Note: Do clear the old RAID configuration to make the disks status as Unconfigured Good if

script unable to find any available physical hard disks that could be used to start setup a new

RAID array.

You can make use the [–-RUN] flag with this script to clear configuration as well.

For example, prepare ism_raid.lst with below command line entry to clear v1 RAID array from

controller c0.

storcli64 /c0/v1 delete

Caution: Verify on your own if you have an Operating System installed on a RAID array and

make sure you will not erase the wrong volume during clear RAID configuration.

Current ISMT RAID configuration only support RAID Level 0,1 and 5. For RAID Level 1, it

requires at least two hardware drives. For RAID Level 5, it requires at least 3 hardware drives

in a server system. If the controller does not support the choosen RAID Level, ISMT will return

you with a error message and you will need to rerun the script again. Current version of ISMT

will use majority of default ‘storcli’ utility values for the controller to complete the selected

RAID configuration.

Use [--SIM] flag to prepare a useful ism_raid.lst input file for re-apply to a group of managed

servers with similar RAID hardware setup. Use [--RUN] flag to load all the commands in

ism_raid.lst on another server or group of servers. User can modify the ism_raid.lst offline to

add more commands before apply it with [--RUN] flag.

Shell Command:

python ism_raid.pyc [-x xml config filename] {--ALL | –i IP address | -g groupname} {

--SIM | --RUN} {--NOW | --RunAtTime}







will be used.

--NOW Execute the script at current system time.

This argument is optional; if this argument and

[--RunAtTime] are not provided, script will

execute at the current system time. This

argument and the [--RunAtTime] argument

has to be used exclusively; script will accept

only one per instance.

--RunAtTime Execute the script at user’s set time. This option

requires user to enter timer’s duration.


[--NOW] are not provided, script will execute at

the current system time. This argument and the

[--NOW] argument has to be used

exclusively; script will accept only one per

instance.

--ALL When this flag is provided, all in-band servers

(with RAID Controllers enabled) in ISMT database

will be accessed via SSH for RAID configuration.

Note: RAID configuration feature is only

applicable to in-band servers stored in ISMT

database.


database for a server during discovery.

Always use this argument instead of [ -g

groupname] or [--ALL] when utilizing this script to

generate inputfile ism_raid.lst. Refer [--SIM]

argument flag usage.



the group.

--SIM When this flag is provided, the script will assist

user to simulate RAID configuration on the


Managed Server stated in [ -i IP address] and

generate a command list input file ism_raid.lst on

successfully executed commands.

This argument can be used together with [--

RUN] argument; script will apply the raid

configuration on the Managed Server while input

file ism_raid.lst is created.

--RUN When this flag is provided, the script will execute

each command line listed in the input file

ism_raid.lst.

Caution: Use this flag carefully with the correct [-

g groupname] argument to include only the

correct group of Managed Servers that have exact

similar RAID drives/array hardware configuration

to avoid failure while execution of all command

lines listed in the inputfile ism_raid.lst.

Ensure you have at least prepare a ism_raid.lst

manually or have one generated from running this

script with [--SIM] argument previously.

Note:

Intel® RST or Intel® RSTe RAID are not supported by ISMT.

Examples of Usage:

python ism_raid.pyc –i 192.168.1.15 –SIM

python ism_raid.pyc –i 192.168.1.15 –SIM --RUN

python ism_raid.pyc –x ism_config1.xml –g INBAND –RunAtTime --RUN

python ism_raid.pyc --ALL –-RUN

python ism_raid.pyc –i 128.101.1.30 –-RUN

4.15 Chassis Identification

The execution of this script turns on or turns off the Chassis Identification LED light for the

purpose of tracking the physical server. With [--ON] argument provided, the LED stays on

permenantly until a [--OFF] argument is sent from Management Server, user may use [-t]

argument to control the LED stay-on interval.


Shell Command:

python ism_identify.pyc [-x xml config filename] {--ALL | –i IP address | -g

groupname} { --ON | --OFF | -t interval} {--NOW | --RunAtTime}






will be used.















instance.


database which has a IPMI logon credentials

stored will be accessed via IPMI channel session

for setting the chassis identify LED status

accordingly.

[-i IP address] A valid IP address which is a IPMI lan IP address

in ISMT database or its associated network IP

address which is host IP address in ISMT

database.




the group. Server that is belong to this

groupname and has a IPMI logon credentials

stored in ISMT database will be applied with the

chassis identify setting.

--ON When this flag is provided, the script will turn on

the chassis identify LED permanently on Managed

Server stated in [ -i IP address] or [ -g

groupname] or [--ALL].

This argument and [--OFF] or [-t interval]



--OFF When this flag is provided, the script will turn off

the chassis identify LED permanently on Managed



This argument and [--ON] or [-t interval]



[-t interval] When this flag is provided, the script will turn on

the chassis identify LED for an interval of t

seconds on Managed Server stated in [ -i IP

address] or [ -g groupname] or [--ALL].

This argument and [--ON] or [--OFF]



Examples of Usage:

python ism_identify.pyc –i 192.168.1.30 --ON

python ism_identify.pyc –ALL –OFF --RunAtTime

python ism_ identify.pyc –g OB --OFF -x ism_config2.xml

python ism_ identify.pyc –i 192.168.1.30 –t 30 --NOW


4.16 Power Setting Action The execution of this script sets a power action on managed servers via ipmitool command.

Power setting actions including turn on (--ON), turn off (--OFF), a hard reset on chassis

intrusion sensor (--RESET), and cold shutdown (--COLD). This feature currently does not

execute graceful or clean shutdowns when sending over power off/shutdown/reset command

to the systems running on operating systems.

Shell Command:

python ism_power.pyc [-x xml config filename] {--ALL | –i IP address | -g groupname}

{ --ON | --OFF | --RESET | --COLD } {--NOW | --RunAtTime}






will be used.















instance.


database which has a IPMI logon credentials


stored will be accessed via IPMI channel session

for setting the chassis power action accordingly.

[-i IP address] A valid IP address which is a IPMI lan IP address

in ISMT database or its associated network IP

address which is host IP address in ISMT

database.



the group. Server that is belong to this

groupname and has a IPMI logon credentials

stored in ISMT database will be applied with the

chassis power action.

--ON When this flag is provided, the script will power up

the Managed Server stated in [ -i IP address] or [

-g groupname] or [--ALL].

This argument and [--OFF],[--RESET] and [-

-COLD] argument has to be used exclusively;

script will only accept either one per instance.

--OFF When this flag is provided, the script will power

down chassis to soft S4/S5 state for Managed



This argument and [--ON],[--RESET] and [--

COLD] argument has to be used exclusively;


Caution: This command does not initiate a clean

shutdown of the operating system prior to

powering down the system.

[--RESET] When this flag is provided, the script will perform

a hard reset on the chassis for Managed Server

stated in [ -i IP address] or [ -g groupname] or [-

-ALL].


This argument and [--ON],[--OFF] and [--

COLD] argument has to be used exclusively;



reboot of the operating system prior to system

reset.

[--COLD] When this flag is provided, the script will provide

a power off interval of at least 1 second for

Managed Server stated in [ -i IP address] or [ -g


Note: No action should occur if chassis power is in

S4/S5 state.

This argument and [--ON],[--OFF] and [--

RESET] argument has to be used exclusively;



shutdown of the operating system prior to

powering down the system.

Examples of Usage:

python ism_power.pyc –i 192.168.1.30 --ON

python ism_power.pyc –ALL –OFF --NOW

python ism_ power.pyc –g OB --RESET -x ism_config2.xml --RunAtTime

python ism_ power.pyc –i 192.168.1.30 –-COLD

4.17 System Firmware Update The execution of this script updates the firmware of managed Intel® Server Systems to new

versions available in ism_fwPackage. Firmware which can be updated using ISMT are BIOS,

ME, BMC, and SDR, User can either update one of them using their respective argument, or

update all using the argument [--UPDATEALL]. The system firmware update is only apply to

those managed servers which could be connected via in-band connectivity. Purely out-of-

band managed servers in ISMT database are not supported. The System Firmware Update

Package (SFUP) must be located at the path specified in ism_config.xml where parameter is

<ism_fwPkgLocation>. The script will check the existence of SFUP on local management

system at the path specified in <ism_fwPkgLocation>. If the –-netshare option is used, the

script will SSH to managed systems then only check the existence of SFUP on the network

share path specified in <ism_fwPkgLocation> on the managed systems.

Notes: This script will create a local temporarily folder “/var/tmp/” on managed server to


store SFUP. This temporarily folder will be removed after system firmware update.

Shell Command:

python ism_updsysfw.pyc [-x xml config filename] [--ALL | –i IP address | -g

groupname] [--UPDATEALL | --BIOS | --ME | --BMC | -- SDR] [--CFG] [--RunAtTime]

[--netshare]






will be used.


database will be accessed via SSH for update

system firmware.




update system firmware, use [–g groupname]

argument option. This [-i IP address] is only

meant for representation of a single server which

was added previously in ISMT database.



the group.

[--UPDATEALL] Update system firmware including BIOS, BMC, ME

and SDR.

To update system firmware, user needs to get

System Firmware Update Package for their Intel®

System Servers and unzip it into ism_fwPackage

folder. If different path is used, user needs to edit


parameter <ism_fwPkgLocation> in

ism_config.xml main configuration file.

User needs to modify the ism_config.xml for the

SFUP folder name according the Product name of

Intel® Server systems or Boards they use.

<S2600KP> For Intel® Server Board S2600KP

Family

<S2600TP> For Intel® Server Board 2600TP

Family

<S2600WT> For Intel® Server Board and Systems

S2600WT Family

<S2600CW> For Intel® Server Board S2600CW

Family

[--BIOS] Update system BIOS only.

[--ME] Update system ME only.

[--BMC] Update system BMC only.

[--SDR] Update system SDR only. It will run only Auto-

SDR. If Auto-SDR is not supported, it will exit.

[--CFG] Update system SDR using legacy mode. It will use

the inputs from “sdrinputs.cfg” to supply the

answers for the interactive questions. User needs

to know the answer for each interactive prompt

and write it in sdrinputs.cfg. Different platform

products may have different sdr prompt

questions, so user needs to have different

sdrinputs in all the SFUP package folder.

Example in sdrinputs.cfg:

1

y

4


y

y

y

y

y

[--netshare] Provide this flag if the Intel® firmware packages

(SFUP) are located at a network shared path.

Ism_updsysfw will copy the firmware packages

from network share path to local path at managed

server and perform the firmware update. It will

remove the firmware package after the update.

Examples of Usage:

python ism_updsysfw.pyc –i 192.168.1.15 --UPDATEALL

python ism_updsysfw.pyc –i 192.168.1.15 --UPDATEALL

python ism_updsysfw.pyc -g groupname –-BIOS

python ism_updsysfw.pyc -g groupname –-SDR –-CFG

python ism_updsysfw.pyc -i 192.168.1.10 –-SDR

python ism_updsysfw.pyc --ALL –-BMC

4.18 Cleanup Use this script to uninstall the previous installed ISMT client-package (including ISMT installed

NRPE plugins) performed by provisioning script from a single or group of managed servers or

all managed servers. This script is intended to help a cleanup on managed servers when user

wish to discontinue to use ISMT management toolkit and need to restore managed server and

management servers before performing the final rpm uninstallation step.

This script can help to remove all Nagios* configuration files added by ISMT during

provisioning and unload these added ISMT Nagios* configuration files from Nagios* main

configuration file <nagios_install_path>/etc/nagios.cfg.

<nagios_install_path>/etc/objects/ism-inbands.cfg

<nagios_install_path>/etc/objects/ism-outbands.cfg

<nagios_install_path>/etc/objects/ismcommands.cfg


To uninstall the mentioned configuration files in above, as well as remove Nagios* Plugins

that were installed during provisioning from Management server, user will need to run this

script with –ALL or [ -i 127.0.0.1 ] option flags.

Shell Command:

python ism_cleanup.pyc [-x xml config filename] {--ALL | –I IP address | -g

groupname} [--netshare]






will be used.


database will be accessed via SSH for cleanup if

they are in-band servers. For out-of-band servers

in the ISMT database, cleanup will only be limited

to remove of the Nagios* configuration files

previously added by ISMT provisioning.




cleanup, use [–g groupname] argument option.

This [-I IP address] is only meant for


previously in ISMT database.

In addition, specifying IP address value of

127.0.0.1 is supported in this script exclusively.

This will instruct the script to cleanup/restore

Management Server from any ISMT added files

during provisioning script executed.



the group.

[--netshare] Provide this flag if the software utilities binaries

for Intel® Server systems are not to be uninstalled


from network shared path specified from

directive <ismSetupLocation> in ism_config.xml.

Examples of Usage:

python ism_cleanup.pyc –i 192.168.1.15

python ism_cleanup.pyc -x ism_confignew.xml –i 192.168.1.15

python ism_cleanup.pyc –g IBSERVER --netshare

python ism_cleanup.pyc -g OBSERVER

python ism_cleanup.pyc -i 127.0.0.1