PI Connector for IPMI 1.0 User Guide - cdn.osisoft.comcdn.osisoft.com/interfaces/3492/PI Connector for IPMI User Guide 1...data for system temperatures, voltages, fans, power supplies,

PI Connector for IPMI 1.0

User Guide

OSIsoft, LLC777 Davis St., Suite 250San Leandro, CA 94577 USATel: (01) 510-297-5800Fax: (01) 510-357-8136Web: http://www.osisoft.com

PI Connector for IPMI 1.0 User Guide© 2014 by OSIsoft, LLC. All rights reserved.No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form orby any means, mechanical, photocopying, recording, or otherwise, without the prior written permissionof OSIsoft, LLC.OSIsoft, the OSIsoft logo and logotype, PI Analytics, PI ProcessBook, PI DataLink, ProcessPoint, PI AssetFramework (PI AF), IT Monitor, MCN Health Monitor, PI System, PI ActiveView, PI ACE, PI AlarmView, PIBatchView, PI Coresight, PI Data Services, PI Event Frames, PI Manual Logger, PI ProfileView, PIWebParts, ProTRAQ, RLINK, RtAnalytics, RtBaseline, RtPortal, RtPM, RtReports and RtWebParts are alltrademarks of OSIsoft, LLC. All other trademarks or trade names used herein are the property of theirrespective owners.U.S. GOVERNMENT RIGHTSUse, duplication or disclosure by the U.S. Government is subject to restrictions set forth in the OSIsoft,LLC license agreement and as provided in DFARS 227.7202, DFARS 252.227-7013, FAR 12.212, FAR52.227, as applicable. OSIsoft, LLC.Version: 1.0.0Published: 07 July 2014

Contents

Introduction to PI Connector for IPMI.......................................................................... 1AF structure for IPMI data................................................................................................................................3

IPMI attributes and values........................................................................................................................... 4

Complete pre-installation tasks for connectors........................................................... 11Software requirements for connectors...........................................................................................................11Connector security.........................................................................................................................................11

Security best practices for PI Connector for IPMI....................................................................................... 12Create the Windows account for the connector..........................................................................................13Create the PI identity for the connector..................................................................................................... 13Map the Windows identity to the PI identity.............................................................................................. 14Enable PI Data Archive access for the PI identity........................................................................................14Enable PI AF database access for the Windows identity............................................................................. 14

Identify the administration port number........................................................................................................ 15Identify administration group users............................................................................................................... 15Install the connector...................................................................................................................................... 15

Configure silent installation for connectors................................................................................................16

Configure the connector........................................................................................... 19Open the PI Connectors Administration Site page......................................................................................... 19Configure the server list.................................................................................................................................19

Modify the server list................................................................................................................................. 20Add data sources to the PI Connector for IPMI...............................................................................................20

IPMI data source configuration settings..................................................................................................... 21IPMI Connection Type settings.................................................................................................................. 23

Start data collection...................................................................................................................................... 23

Connector administration......................................................................................... 25Verify data collection.....................................................................................................................................25Diagnostics....................................................................................................................................................25

Advanced Diagnostics............................................................................................................................... 26Change connector installation settings.......................................................................................................... 27Uninstall the connector..................................................................................................................................27

Uninstall the connector in silent mode.......................................................................................................28

Technical support and other resources....................................................................... 29

PI Connector for IPMI 1.0 User Guide iii

Contents

iv PI Connector for IPMI 1.0 User Guide

Introduction to PI Connector for IPMI

PI Connector for IPMI (Intelligent Platform Management Interface) lets you monitor devicedata for out-of-band management. The PI System archives platform-status information, such asdata for system temperatures, voltages, fans, power supplies, and chassis intrusion. PIConnector for IPMI models the IPMI data, builds and configures the assets and PI points tomodel the platform, and then sends the IPMI data to PI Asset Framework (PI AF) and PI DataArchive.

Operational overview

PI Connector for IPMI processes data from IPMI-compliant servers. Once the PI Connector forIPMI is configured to collect data, it performs the following operations:1. Discovery2. IPMI server communication3. IPMI server inventory4. Asset creation5. Data collectionDiscovery

After you define a subnet range, the connector discovers IPMI-compliant servers. The PIConnector for IPMI sends an IPMI ping packet via UDP to each address in the subnet range.When it receives a response from the given address, the connector inventories the IPMI server.Discovery checks repeat once every 5 minutes for the first hour after data collection has beenstarted or when a change in configuration has been detected. After the first hour, the discovery

PI Connector for IPMI 1.0 User Guide 1

checks repeat every hour, and the connector then inventories any newly-discovered IPMIservers.IPMI server communication

Communication with an IPMI server is required during the following operations:• Discovery• IPMI server inventory• Data collection

All communication is via UDP, and the communication channel is only open while the PIConnector for IPMI completes and closes the operation.The discovery operation uses IO Completion Ports to send IPMI ping requests and waits forIPMI responses within a configured subnet. Multiple subnets can be checked simultaneously.By default, the connector selects the least-secure cipher suite type for IPMI 2.0 communication,if supported, or the most-secure authentication type for IPMI 1.5 communication supported byboth the IPMI server and the connector. Any particular subnet can have IPMI serversconfigured to communicate with different types of security. You can force a specific type ofsecurity in the configuration over a complete subnet; however, this is not recommendedbecause servers that do not support the configured type of security will fail to communicatewith the connector.IPMI server inventory

During the inventory process, the PI Connector for IPMI:1. Reads the chassis and sensor data repository from the IPMI server.2. Inventories the IPMI server and creates the PI AF and PI Data Archive models for the IPMI

data.3. Checks the IPMI server every 60 minutes after the last successful inventory check for

timestamp changes in the sensor data repository.4. Inventories the IPMI server after a repository timestamp change is detected on the IPMI

server, updating the PI System data.5. Repeats the inventory check every 30 seconds after an error, until a successful inventory

check.Asset creation in PI AF

The PI AF database defined in the connector configuration contains the PI AF root node pathwhich defines the IPMI connector element. This root node path contains a list of elements fromthe inventoried IPMI servers. Under the root node, each IPMI server has its own node, and thennodes for the IPMI sensors within the IPMI server nodes. PI point data references to the PIData Archive define the sensor data readings.Data collection

The connector collects data for each successfully inventoried IPMI server from the availablesensors by polling the IPMI server for sensor data readings at the configured scan interval. Thesensor readings are then used to update the PI points in the PI Data Archive.


2 PI Connector for IPMI 1.0 User Guide

AF structure for IPMI dataYou can view the PI Asset Framework elements and attributes for the PI Connector for IPMIusing PI System Explorer.In this example, four IPMI server elements were created under the PI Connector for IPMIelement.

The inventoried IPMI server element is based on the IPMI chassis element template and isnamed using the IP address of the IPMI server.The IPMI chassis element template contains an IPMI Server Settings attribute, along withattributes common to the template.

Chassis element templates contain nodes for sensors. Sensors can be discrete or analog sensortypes. Analog sensor types can contain one or more additional discrete sensor types. Eachsensor element is nested within its parent node.



IPMI attributes and values

IPMI element attributes are based on the IPMI element template for that data. You can view theattributes and their values using PI System Explorer.

IPMI chassis attributes

The IPMI server element is based on the IPMI chassis element template. Element names usethe IP address of the IPMI server. Each IPMI server element contains attributes common to allIPMI chassis element templates.

Attribute Description Values

Chassis Intrusion Chassis intrusion active Boolean:• True (Active)• False (Inactive)

Cooling Fan Fault Cooling fan fault detected Boolean:• True (Fault detected)• False (Not detected)

Diag Button Disabled Diagnostic Interrupt buttondisable allowed

Boolean:• True (Allowed)• False (Not allowed)

Drive Fault Drive fault detected Boolean:• True (Fault detected)• False (Not detected)

Front Panel Lockout Front Panel Lockout active(power off and reset via chassispush-buttons disabled)

Boolean:• True (Active)• False (Inactive)

IP Address Chassis IP address String:xxx.yyy.zzz.nnn

IPMI Server Settings Version 1.5 and 2.0 settings IPMI Server Settings attributecontains multiple attributes. SeeIPMI Server Settings attribute.

Last Power Event The cause of the last power event Discrete:• IPMI• Power Fault• Power Interlock• Power Overload• AC Failed

Main Power Fault Fault detected in main powersubsystem

Boolean:• True (Fault detected)• False (Not detected)

Node Name Chassis node name String:xxx.yyy.zzz.nnn (Default IPaddress)




Power Button Disabled Power button disabled Boolean:• True (Disabled)• False (Not disabled)

Power Control Fault Controller attempted to turn onor turn off system power, but thesystem did not enter the desiredstate.

Boolean:• True (Fault detected)• False (Not detected)

Power Interlock Interlock. Chassis is presentlyshut down because a chassispanel interlock switch is active.IPMI 1.5 only

Boolean:• True (Interlock detected)• False (Not detected)

Power Overload System shutdown because ofpower overload condition

Boolean:• True (Overload detected)• False (Not detected)

Power Restore Policy Power restore policy Discrete:• last_state• turn_on• always_off• unknown

Reset Button Disabled Reset button is disabled Boolean:• True (Disabled)• False (Not disabled)

Sleep Button Disabled Sleep button is disabled Boolean:• True (Disabled)• False (Not disabled)

IPMI Server Settings attribute

The IPMI chassis element template contains an IPMI Server Settings attribute. You canexpand the IPMI Server Settings attribute in PI System Explorer to see its associatedattributes.


Login Anonymous Enabled Anonymous login enabled. Theconnector does not allow thisoption for login.

Boolean:• True (Enabled)• False (Disabled)

Login KG Default Key Generation (KG) enabled.The connector does not allowthis option for login.


Login Non Null UsernameEnabled

Non null username login enabled Boolean:• True (Enabled)• False (Disabled)




Login Null UsernameEnabled

Null username login enabled. Theconnector does not allow thisoption for login.


Login OEM Auxiliary Data OEM login type allowed. Theconnector does not allow thisoption for login.


Login OEM ID OEM ID login type allowed. Theconnector does not allow thisoption for login.


Login Per MessageAuthentication

Per message login authenticationstatus


Login User LevelAuthentication

User level login authenticationstatus


Supports v1.5 Connections Supports connection via IPMIversion 1.5

Boolean:• True (Supported)• False (Not supported)

Supports v2.0 Connections Supports connection via IPMIversion 2.0


Supports v2.0 ExtendedCapabilities

Supports v2.0 extendedcapabilities


Using IPMI Connection Type of authentication/ciphersuite communication usedbetween the connector and IPMIserver.The connector will alwayschoose the lowest cipher suitetype of IPMI version 2.0 ifavailable; otherwise, theconnector will choose the highestauthentication type of IPMIversion 1.5 supported.

Discrete:Refer to the IPMI Version 1.5authentication settings and IPMIVersion 2.0 Cipher Suite settings.See IPMI Connection Typesettings

v1.5 SupportAuthentication MD2

Supports authentication type.The connector does not supportthis authentication type.


v1.5 SupportAuthentication MD5

Supports authentication type. Boolean:• True (Supported)• False (Not supported)




v1.5 SupportAuthentication None



v1.5 SupportAuthentication OEM



v1.5 SupportAuthentication StraightPassword



v2.0 Support Cipher SuiteID (0) None/None/None

Supports cipher suite type. Boolean:• True (Supported)• False (Not supported)

v2.0 Support Cipher SuiteID (1) SHA1/None/None


v2.0 Support Cipher SuiteID (2) SHA1/SHA1_96/None


v2.0 Support Cipher SuiteID (3) SHA1/SHA1_96/CBC-128


v2.0 Support Cipher SuiteID (4) SHA1/SHA1_96/xRC4_128

Supports cipher suite type.The connector does not supportthis cypher suite type.


v2.0 Support Cipher SuiteID (5) SHA1/SHA1_96/xRC4_40



v2.0 Support Cipher SuiteID (6) MD5/None/None


v2.0 Support Cipher SuiteID (7) MD5/HMAC_MD5_128/None


v2.0 Support Cipher SuiteID (8) MD5/HMAC_MD5_128/CBC_128


v2.0 Support Cipher SuiteID (9) MD5/HMAC_MD5_xRC4_128






v2.0 Support Cipher SuiteID (10) MD5/HMAC_MD5_128/xRC4_40



v2.0 Support Cipher SuiteID (11) MD5/MD5_128/None



v2.0 Support Cipher SuiteID (12) MD5/MD5_128/CBC_128



v2.0 Support Cipher SuiteID (13) MD5/MD5_128/xRc4_128



v2.0 Support Cipher SuiteID (14) MD5/MD5_128/xRC4_40



IPMI sensor attributes

Each IPMI server contains one or more sensors. The two categories for sensor types arediscrete and analog.Discrete sensor attributes

There are many types of discrete sensors. All discrete sensor types have the same attributes.Attribute Description Values

Entity ID Indicates the physical entity thatthe sensor is monitoring or thatis otherwise associated with thesensor.

String:Entity type name


Sensor ID String name associated withsensor

String

State Sensor state. This is a PI pointreference.

PI point:Digital

Sensor Type Sensor type String

Analog sensor attributes

The four analog sensor types are:• Current• Fan



• Temperature• Voltage

All analog sensor types have the same attributes. In addition, each analog sensor type can alsohave one or more associated discrete sensor types.


Entity ID Indicates the physical entity thatthe sensor is monitoring or thatis otherwise associated with thesensor.

String:Entity type name


Lower Critical Optional: Lower criticalthreshold

Integer/Float

Lower Non Critical Optional: Lower non-criticalthreshold

Integer/Float

Lower Non Recoverable Optional: Lower non-recoverablethreshold

Integer/Float

Nominal Reading Optional: Nominal reading Integer/FloatValue Scaled sensor reading value. This

is a PI point reference.PI point:Float 64

Sensor Accuracy % Sensor accuracy percentage PercentageSensor Direction Indicates whether the sensor is

monitoring an input or outputrelative to the given entity.

Discrete:• Unspecified• Not applicable• Input• Output

Sensor ID String name associated withsensor

String

Sensor Maximum Optional: Sensor maximumreading

Integer/Float

Sensor Minimum Reading Optional: Sensor minimumreading

Integer/Float

State Sensor status. This is a PI pointreference.

PI point:Digital

Sensor Type Sensor type StringTolerance Sensor tolerance Integer/FloatUnits Sensor unit type StringUpper Critical Optional: Upper critical

thresholdInteger/Float

Upper Non Critical Optional: Upper non-criticalthreshold

Integer/Float




Upper Non Recoverable Optional: Upper non-recoverablethreshold

Integer/Float

Raw analog sensor attributes

The connector can be configured to retrieve raw values for the Current, Fan, Temperature, andVoltage analog sensor types by linking a raw value element to the corresponding analogsensor.


B Signed additive 'offset' IntegerIP Address Chassis IP address String:

xxx.yyy.zzz.nnn

K1 Signed exponent IntegerK2 Signed result exponent IntegerLinearization Linearization (L) function used

to calculate scaled valueDiscrete:• linear• ln• log10• log2• e• exp10• exp2• 1/x• sqr(x)• cube(x)• sqrt(x)• cube-1(x)

M Constant multiplier IntegerSensor Data Format Data format Discrete:

• unsigned• 1's complement• 2's complement (signed)

Value Raw reading. This is a PI pointreference.The Reading value determinesthe Scaled Reading value inthe associated sensor using the y= L[(Mx+(B *10^K1))*10^K2] function.

PI point:Int32



Complete pre-installation tasks for connectors

Before installing the software, complete the following tasks.Procedure

1. Verify your system meets the software requirements. See Software requirements forconnectors.

2. Configure security for the connector and your network. See Connector security.3. Identify the administration port number.4. Identify administration group users.

Software requirements for connectorsConnectors require the following versions of related software:• PI System

◦ PI Data Archive 3.4.380.36 or later◦ PI Asset Framework 2012 or later

• Microsoft Windows◦ 64-bit system◦ Server class: Windows Server 2008 or later◦ Client class: Windows Vista SP2 or later◦ Framework: .NET 3.5 (included with the OSIsoft Prerequisites Kit)

• Web browser◦ HTML5-compliant web browser for access to the PI Connector Administration Site page

Connector securityConnector access to PI Data Archive and PI Asset Framework (PI AF) servers is based onWindows Integrated Security. To use Windows Integrated Security, you must use PI DataArchive 3.4.380.36 or later and PI AF 2012 or later.

Note:Configure security settings before starting the connector.

Configure security settings for connectors to provide the connector secure access to your PISystem. Security must be configured to allow the connector to write to both the PI DataArchive and PI AF servers. For more information about configuring security, refer to thefollowing guides:• For PI Data Archive, see PI Data Archive Introduction to System Management Guide

• For PI AF, see PI Asset Framework Installation and Upgrade Guide


Some data source protocols are inherently insecure. OSIsoft recommends you review thesecurity standards for your data source to determine the correct level of security measuresnecessary to secure your system.

Security best practices for PI Connector for IPMI

To mitigate security vulnerabilities, any system connected to the internet that runs theIntelligent Platform Management Interface (IPMI) should adhere to the security practiceslisted in this topic. For more information about security considerations when using IPMI, seethe United States Computer Emergency Readiness Team (US-CERT) site for Alert (TA13-207A)Risks of Using the Intelligent Platform Management Interface (IPMI) (https://www.us-cert.gov/NCAS/ALERTS/TA13-207A).OSIsoft recommends the following security practices:• Restrict IPMI to Internal Networks

Restrict IPMI traffic to trusted internal networks. Traffic from IPMI (usually UDP port 623)should be restricted to a management VLAN segment with strong network controls. Scanfor IPMI usage outside of the trusted network and monitor the trusted network forabnormal activity.

• Use Strong Passwords

Devices running IPMI should have strong, unique passwords set for the IPMI service.For more information about password security, see the United States Computer EmergencyReadiness Team (US-CERT) site:◦ Security Tip (ST04-002) Choosing and Protecting Passwords (www.us-cert.gov/ncas/

tips/ST04-002)◦ Password Security, Protection, and Management (https://www.us-cert.gov/sites/

default/files/publications/PasswordMgmt2012.pdf)• Encrypt Traffic

Enable encryption on IPMI interfaces, if possible. See your manufacturer manual for detailson how to set up encryption.

• Require Authentication

Many IPMI-enabled devices use the default authentication option "cipher 0," which allowsauthentication to be bypassed.Disable "cipher 0" to prevent attackers from bypassing authentication and sendingarbitrary IPMI commands.Additionally, disable anonymous logins.

• Sanitize Flash Memory at End of Life

Follow manufacturer recommendations for sanitizing passwords. If none exists, destroy theflash chip, motherboard, or other areas the IPMI password may be stored.

• Identify Affected Products

Many system products will be affected by IPMI security. Identify those products in yoursystem, such as:



https://www.us-cert.gov/NCAS/ALERTS/TA13-207A

https://www.us-cert.gov/NCAS/ALERTS/TA13-207A

https://www.us-cert.gov/sites/default/files/publications/PasswordMgmt2012.pdf

◦ Most server products◦ HP Integrated Lights Out◦ Dell DRAC◦ IBM Remote Supervisor Adapter

Create the Windows account for the connector

For security purposes, run the connector on a host that is a member of a Windows domain anduse a domain account for its identity. When choosing an account type, consider that:• Windows domain accounts are the more secure option for hosting the connector. In a

domain environment, a domain controller performs authentication for centralized control.• Windows workgroups are the less secure option for hosting the connector. In a workgroup

environment, all computers are peers and authentication is performed locally.Before you start

Ensure your computer is part of a Windows domain or workgroup. Computer domaininformation can be found in the Control Panel system information, in the Computer name,domain, and workgroup settings area.Procedure

1. Create the account. ◦ If your computer is part of a domain, create a dedicated domain account for the

connector.You must have domain administrator privileges to create domain accounts.

Note:For domain accounts, the account should not be a member of the host's localadministrators group.

◦ If your computer is part of a workgroup, create identical local accounts for everymachine that hosts either the connector, the PI Data Archive server, or PI AF server,using the same user name and password for each account.You must have local administrator privileges to create workgroup accounts.

Create the PI identity for the connector

Create the PI identity to give the connector permission to write data to the PI Data Archive andthe PI Asset Framework (PI AF) servers.Procedure

1. Launch PI System Management Tools (PI SMT).2. Click Security > Identities, Users & Groups , and then click the PI Identities tab.3. Right-click within the pane, and then click New Identity.

The New Identity window opens.4. Configure the settings for the identity.



The PI identity for the connector must have permission to write to both the PI Data Archiveand the PI AF servers.

5. Click Create.

Map the Windows identity to the PI identity

Procedure

1. Launch PI System Management Tools.2. Click Security > Identities, Users & Groups, and then click the PI Identities tab.3. Double-click the PI identity for the connector, and then add the account to be used by the

connector to the Windows Account field.4. Add the PI identity to the PI Identity field, and then click OK.

Enable PI Data Archive access for the PI identity

Provide the new PI identity for the connector with the required access to the PI Data Archiveusing PI System Explorer.Before you start

You must have already created a PI identity for the connector.Procedure

1. Launch PI System Explorer, and then click Security > Database Security.2. Right-click the PIPOINT table, and then click Properties.

The Security window opens.3. Click Add to open the Select window, and then select the identity to add to the access

control list.4. Enable read and write access to the PIPOINT table, and then click OK to save the settings

and close the window.

Enable PI AF database access for the Windows identity

Provide the new PI identity for the connector with the required access to the PI AssetFramework (PI AF) database using PI System Explorer.Before you start

You must have already created a PI identity for the connector.Procedure

1. Launch PI System Explorer, and then click the Database button. The Security Database window opens.

2. Click the security icon . The Permission for Databases window opens.



3. Click Add, and then select the Windows identity for the connector.4. Select the Read/Write and Read/Write Data check boxes, and then click OK.5. Click OK to save the settings and close the window.

Identify the administration port numberThe connector service uses a TCP port to host the administration web service.Procedure

1. Identify the administration port number before installing the connector software. You will be prompted to enter this port number during installation.

Identify administration group usersTo configure and administer the connector, users must belong to the local Windows OSIsoft PIConnectors Administrators security group.Procedure

1. Identify all local or domain users that require administrative privileges to the OSIsoft PIConnectors Administrators group. You will be prompted to add these users during installation.

Note:Use care when selecting users for the administration group. Users will be able tolocally or remotely stop and start the connector, and modify configurations.

Install the connectorIf the PI System software included in the connector setup kit has not been installed yet, theconnector setup wizards prompts you to configure the additional software included in thesetup kit before installing and configuring the connector software.To uninstall the connector software, see Uninstall the connector.Procedure

1. Launch the connector installation kit.2. Set the extraction path for the installation files and click OK.

The connector setup wizard opens.3. Install and configure all required software using the installation wizard.

For more information about installing the PI SDK, see the PI SDK and PI API Online Help Filesdocumentation available from the OSIsoft Tech Support site.The wizard installs the prerequisite software and prompts you to configure the connectorinstallation.

4. Configure the following items:



◦ Administration port number for hosting the administration web service◦ Windows service account information◦ Optional: Alternate file path for buffer and other local files◦ Optional: PI System Customer Experience Improvement Program setting

5. Click Install.6. Add all local or domain users that require administrative privileges to the OSIsoft PI

Connectors Administrators group, and then click Next. Users must belong to this group to configure and perform administrative tasks for theconnector.

7. Click Finish to exit the installer.

Configure silent installation for connectors

You can install this software with the Windows silent installation feature. Sometimes called anunattended installation, silent installation requires no feedback during the setup process.System administrators with an automated software distribution application might use silentinstallation to deploy software automatically to large numbers of corporate desktops.Modify the silent.ini file to configure silent installation. Configuring the silent.ini filedetermines items that you would have selected during a normal installation with the setupwizard.Before you start

Complete pre-installation tasks for connectors.Silent installation requires .NET 3.5 or later.Procedure

1. Prepare the silent installation file path and identify the status of supporting software.a. Run the self-extracting connector executable file.Unzip the setup kit files and run the

setup.ini file. The setup wizard opens. You will only complete the step to set the extraction path.

b. Enter an extraction path and click OK.c. Cancel the installation.

2. Go to the executable folder, and open the silent.ini file in a text editor.3. Modify the the COMMANDLINE section for module 11 for the connector.

See the silent.ini file included in the setup kit for more details about each of theconfigurable settings:◦ Required: SERVICE_ACCOUNT. Set this property to the name of the service account for

the computer.◦ Required: SERVICE_ACCOUNT_PASSWORD. Set this property to the password for the

service account for the computer.◦ Optional: USERPORT



◦ Optional: ACCEPT_TELEMETRY◦ Optional: ALTERNATEFILEPATH

4. To run the silent installation, open a command prompt window, navigate to the extractionpath, and enter setup.exe -f silent.ini.





Configure the connector

To begin collecting data, add and configure the servers and data sources for the connector.Procedure

1. Open the PI Connectors Administration Site page.2. Configure the server list.3. Add data sources to the PI Connector for IPMI.4. Start data collection.

Open the PI Connectors Administration Site pageConfigure and perform administration tasks for the connector from the PI ConnectorAdministration Site page using an HTML5-compatible browser.Before you start

In order to configure the connector:• The user account must belong to the local Windows OSIsoft PI Connectors Administrators

security group.• The connector service must be running. From the Windows menu, run services.msc to

open the Services window, and then locate and start the connector service.Configure your firewall to permit remote access to the service port if you want to access the PIConnector Administration Site from remote computers.Procedure

1. From the Windows menu, click All Programs > PI System > PI Connector. Note:Some web browsers will not recognize the security certificate from the administrationsite. Allow your browser to access the site.

The PI Connector Administration Site page opens to the main Overview page.

Configure the server listAdd and configure PI Data Archive and PI AF for communication with the connector.

Note:The connection status of a server stays Disconnected until the connector beginscollecting data.

Procedure

1. On the PI Connector Administration Site page, click the Server List link.


The Server List pane displays the PI Data Archive and PI AF servers for the connector.2. Add and configure one or more PI Data Archive servers to the PI Data servers list, and then

click Add. ◦ PI Data servers

A descriptive name or alias for the PI Data Archive server.◦ Host name or IP Address

The host name or IP address of the PI Data Archive server.3. Add and configure one or more PI AF servers to the PI Asset servers list, and then click Add.

◦ PI Asset servers

A descriptive name or alias for the PI AF server.◦ Host name or IP Address

The host name or IP address of the PI AF server.4. Enter additional information for the PI AF server, and then click Keep these settings.

◦ PI Asset Database

A descriptive name for the PI AF database.◦ Root PI Asset Path

The root path for PI AF.◦ PI Data server

The name or alias for the associated PI Data Archive.

Modify the server list

Modify the server list for the connector from the PI Connector Administration Site page.You can add and remove servers without stopping the connector service.Procedure

1. In the navigation pane, click Server List, or click the Add or modify servers link in the Servers configured to receive data from the PI Connector area.

2. To modify the server list, choose one of the following options:◦ Add a new server.◦ Remove an existing server.

3. To modify an existing server, delete the server, then add it with the new configurations.

Add data sources to the PI Connector for IPMIAdd data sources and configure them for data collection from the PI Connector AdministrationSite page.



Procedure

1. From the Overview page, click the Data Source List link, or click Add or modify data sourcesin the Data source for the PI Connector for IPMI area.

2. To add a new data source, enter the name in the Data source name field, and then click Addand configure.

Note:All Data source name values for the PI Connector for IPMI must be unique.

The configuration window opens.3. Enter and select your data source configurations, and then click Save. For the configuration

settings, see IPMI data source configuration settings. The Overview page opens and lists the new data source.

IPMI data source configuration settings

Each IPMI data source can be added to the connector using the following configurations.

• Data source description

Optional: Description of the data source configuration.• Start Address

Required: The starting IP address for the range of servers.The IP address must be in xxx.yyy.zzz.nnn format.The xxx.yyy.zzz value must match the xxx.yyy.zzz value for End Address.The nnn value must be less than or equal to the nnn value for End Address.

• End Address

Required: The ending IP address for the range of servers.The IP address must be in xxx.yyy.zzz.nnn format.The xxx.yyy.zzz value must match the xxx.yyy.zzz value for Start Address.

The nnn value must be greater than or equal to the nnn value for Start Address.• Port

Required: The UDP communication port of the IPMI servers for the defined range of servers.The default port number is 623.

• User Name

Required: Username for communicating with the IPMI server.Username must have USER level privilege configured on the IPMI server.Maximum length for this field is 16 characters.



• Password

Required: Password for authenticating communicating with the IPMI server.The Password field is a confidential field.Maximum length for this field is 20 characters.

• IPMI Connection Type

Optional: Type of authentication/cipher suite level communication used between theconnector and the IPMI server.The IPMI specification requires an authentication type for IPMI version 1.5 communicationand a cipher suite type for IPMI version 2.0 communication.Default: AutoDetect (recommended). Selects the least-secure cipher suite type for IPMI 2.0communication, if supported, or the most-secure authentication type for IPMI 1.5.

Caution:Configuring a specific authentication or cipher suite level can cause errors if the rangeof servers is not configured to support the selected authentication/cipher suite level.For more information about supported authentication/cipher suite levels, see IPMIConnection Type settings.

• Sensor Scan Interval

Required: The time interval, in seconds, that the connector polls the IPMI server for datacollection.Default: 60Interval Range: 10 - 86400

• Retrieve Raw Values

Optional: For analog types only. This option only applies to Current, Fan, Temperature, andVoltage analog sensors.If selected, the connector creates the IPMI Raw Analog element associated with the IPMIAnalog Sensor.

• All

Optional: If selected, all available sensors are read from the IPMI server.Due to different IPMI server configurations, the IPMI server might only contain a subset ofall the sensor types defined in the IPMI specification.If not selected, at least one sensor must be selected for data collection.

• Other IPMI Sensors

Optional: The configuration page lists the IPMI sensors available for data collection. You canselect sensors to be read from the IPMI server.Due to different IPMI server configurations, the IPMI server might only contain a subset ofall the sensor types defined in the IPMI specification.If not selected, at least one sensor must be selected for data collection.



IPMI Connection Type settings

The IPMI specification requires an authentication type for IPMI version 1.5 communicationand a cipher suite type for IPMI version 2.0 communication.To prevent errors, the range of IPMI servers must be configured to support the authenticationor cipher suite level for the connector. For more information about the IPMI ServerSettings attributes and the supported authentication and cipher suite levels, see IPMI ServerSettings attribute.IPMI Version 1.5 Authentication settings

Type ID Authentication

0 None2 MD5

IPMI Version 2.0 Cipher Suite settings

Type ID Authentication Integrity Confidentiality

0 None None None1 SHA1 None None2 SHA1 SHA1_96 None3 SHA1 SHA1_96 CBC_1286 MD5 None None7 MD5 HMAC_MD5_128 None8 MD5 HMAC_MD5_128 CBC_128

Start data collectionBegin data collection from the PI Connector Administration Site page after configuring theconnector.Procedure

1. From the Overview page, find the connector in the Status of the PI Connector area.2. Click Start the PI Connector.





Connector administration

Perform administrative tasks from the PI Connector Administrative Site page.Topics in this section

• Verify data collection• Diagnostics• Change connector installation settings• Uninstall the connector

Verify data collectionView PI tag time stamps and current values using PI System Management Tools (PI SMT) toconfirm that the connector is collecting data.Before you start

Ensure the connector service status is Running. From the Start menu, run services.msc,then locate the connector service.Procedure

1. Open PI SMT and click System Management Tools > Data > Current Values, and then clickthe Tag Search button. The Tag Search window opens.

2. Change the Point Class value to base.3. Enter the product name for the connector, surrounded by asterisks, in the Tag Mask field,

and then click Search. For example, enter *IPMI* when searching for PI tags for PI Connector for IPMI.

4. Select one or more tags and click OK. The Current Values area displays the current time stamp and value of the PI tag.

DiagnosticsDiagnostic information is available by navigating to the PI Connector Administration Site pageand clicking the Diagnostics link. Navigate to each diagnostic section by clicking its tab.PI Data Server Connections

Each PI Data Archive server on the server list displays the name, connection status, number ofbuffers, and buffered events.


PI Asset Server Connections

Each PI Asset Framework (PI AF) server on the server list displays the name, connectionstatus, number of buffers, buffered events, and PI asset count.Advanced Diagnostics

The Advanced Diagnostics tab provides additional diagnostics for the connector. For moreinformation, see Advanced Diagnostics.

Advanced Diagnostics

View information about streams, message logs, and buffer disk usage in the AdvancedDiagnostics tab.Streams

A stream represents a series of events from a data source like a sensor or device. A stream hasa schema that defines how to assign values to the properties of the data source.• ID

The unique string ID of a connector data stream.• Schema

The name of the data type schema.• OnNextCount

The accumulated event count from a connector data stream.Message Logs

The Message Logs contain important status events and errors generated by the connector.• Timestamp

The time the message was logged.• Message

The event message.Buffer Disk Usage

The buffer contains data that has been collected but not yet sent to the target destination.• Name

The name of the buffer disk.• CurrentDiskUsage

The amount of disk space currently used by a buffer file. The connector allocates buffer fileson startup and when it needs additional buffers. The size of the buffer file is not anindication of the amount of buffered data.



• MaxDiskUsage

The maximum amount of disk space for buffers.• PercentDiskUsed

The percentage of total disk space being used.

Change connector installation settingsChange installation settings for the connector in order to:• Reinstall the connector software• Replace missing files from the installation• Change the administration port number• Change participation in the PI System Customer Experience Improvement Program• Change the location of the buffer and data files• Change the service identity

Note:

To remove users from the PI Connectors Administration Group, modify the WindowsUser Accounts configuration through the Windows Control Panel.

Procedure

1. Open Programs and Features from the Windows menu, select the connector program, andthen click Change.

Note:Changing installation settings stops the connector service.

The setup wizard opens.2. Click Next.

The installation and change options are shown.3. Click Change to modify the settings.4. Change installation configurations using the wizard.

Uninstall the connector

Procedure

1. Uninstall the connector in one of two ways:◦ Launch the installation kit, and then click Remove.◦ From the Windows menu, click Control Panel > Programs and Features, then select the

connector and click Uninstall.



Uninstall the connector in silent mode

Use silent mode to uninstall the connector from the command line.Before you start

The original ConnectorName.msi file or a copy of the same version must be used for silentuninstall.Procedure

1. Open a command prompt window and enter msiexec -x ConnectorName.msi -qn.



Technical support and other resourcesFor technical assistance, contact OSIsoft Technical Support at +1 510-297-5828 or through theOSIsoft Tech Support website (https://techsupport.osisoft.com). The website offers additionalcontact options for customers outside of the United States.When you contact OSIsoft Technical Support, be prepared to provide this information:

• Product name, version, and build numbers• Details about your computer platform (CPU type, operating system, and version number)• Time that the difficulty started• Log files at that time• Details of any environment changes prior to the start of the issue• Summary of the issue, including any relevant log files during the time the issue occurred

The OSIsoft Virtual Campus (vCampus) website (http://vcampus.osisoft.com) hassubscription-based resources to help you with the programming and integration of OSIsoftproducts.


https://techsupport.osisoft.com

http://vcampus.osisoft.com

Technical support and other resources


PI Connector for IPMI 1.0 User Guide - cdn.osisoft.comcdn.osisoft.com/interfaces/3492/PI Connector for IPMI User Guide 1...data for system temperatures, voltages, fans, power supplies,

Documents