Eaton Ipm 2.3.0 User Guide
Eaton Ipm 2.3.0 User Guide
User guide
National Electrical Code and NEC are registered trademarks of National Fire Protection Association, Inc.
Microsoft®, Windows®, and Windows Server® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
VMware is a registered trademark or trademark of VMware, Inc. in the United States and/or other jurisdictions.
No part of this document may be reproduced in any way without the express written approval of Eaton Corporation.
Table of Contents
1 General information 9
1.1 The virtual appliance .............................................................................................................................................9
1.1.1 Technical specifications ......................................................................................................................................9
1.1.2 Virtual appliance console ....................................................................................................................................9
1.2 Initial setup & configuration................................................................................................................................11
1.2.1 Initial commissioning ........................................................................................................................................11
Login Wizard.....................................................................................................................................................11
Initial Login.......................................................................................................................................................11
End User License Acceptance..........................................................................................................................12
Network configuration.....................................................................................................................................13
Data center creation (Optional) ......................................................................................................................13
Data center layout configuration (Optional) ..................................................................................................14
Software license or subscription configuration .............................................................................................14
Finalize data center asset configuration.........................................................................................................15
1.3 Asset Management...............................................................................................................................................15
1.3.1 Asset Management from the User Interface .....................................................................................................15
Asset creation...................................................................................................................................................15
Input Power Chain Configuration ...................................................................................................................16
Manually add a new asset................................................................................................................................16
Edit an existing asset .......................................................................................................................................18
Asset Mass configuration .................................................................................................................................19
Dynamic groups of assets ................................................................................................................................23
1.3.2 T&H Sensors Management ................................................................................................................................25
1.3.3 ePDU G3/G3+ Daisy Chaining ............................................................................................................................27
1.3.4 How to use the CSV file for commissioning ......................................................................................................28
Initial CSV Creation ..........................................................................................................................................28
CSV upload .......................................................................................................................................................29
Upload Errors ...................................................................................................................................................29
1.4 Alarms Management ............................................................................................................................................31
1.4.1 Introduction .......................................................................................................................................................31
1.4.2 Alarm Lifecycle ...................................................................................................................................................33
1.5 User Management ................................................................................................................................................35
1.5.1 Local Users .........................................................................................................................................................35
1.5.2 Remote Users .....................................................................................................................................................36
1.6 Automation...........................................................................................................................................................36
1.6.1 Trigger events.....................................................................................................................................................37
1.6.2 Actions ...............................................................................................................................................................39
1 General information
Note that the above 64 GB value is a default setting that may be modified during the deployment of the Virtual
Appliance.
The disk storage may more specifically be set to Thin provisioning, to only consume the currently needed
space, or to Thick provisioning to ensure that the needed storage space is reserved.
Note: Use of "System Diagnostic" should only happen on request of an Eaton support representative.
Note: To later access to the web interface, an IP address must be set to your SW instance.
If DHCP is enabled on your network at deployment time, you can start with the IP address automatically
assigned and then use it to connect to the web interface to either stay in dynamic mode or change it for a
static IP assignment.
In case, you have no DHCP access available in your network at the deployment time, you must configure
the appropriate static IP address of your SW instance using "Network Settings" in this console.
Initial Login
After accepting the self-signed certificate, you are presented with the login page.
As you are logging into your IPM Editions application for the first time, you will be required to enter the factory default
username and
password which are set to:
Username = admin
Password = admin
As you type in the password, the password details are obscured from view so please ensure that you enter the
password carefully.
During the initial login, the system requires that you change the default admin password for increased security.
• You are presented with a message requesting the current admin password ("admin") and a new password
which you must also enter a second time to ensure you have entered it correctly.
• Follow the password format recommendations on the tooltip in order to define a secure password;
• A secure password is mandatory.
The factory default password security policy requires that you enter a password with at least 8 characters
and that includes a minimum of 1 number, and 1 special character.
You may modify the password strength policy in the settings of the application. See User Management for
more information.
• Click Continue
Network configuration
On the next page, you are presented with the network configuration settings.
Confirm that the network configuration settings are correct.
If no changes are necessary, proceed to the next step, simply by clicking on Next.
NOTE If changes are made on the network configuration page, you will be automatically logged out when all
the steps of the wizard are complete in order to restart the network services.
Please note that required fields marked with an asterisk "*" and are mandatory. Also note that the system has
a pre-defined asset location hierarchy (Data center -> Rooms -> Rows -> Racks -> devices).
This wizard step will automatically generate the specified topology with the desired number of Rooms, Rows and
Racks.
NOTE The data center layout can be updated later on from the Setting Views page.
• To proceed without a license key, click the Skip & Import/Create devices button.
• To activate a license, enter a valid activation ID and click Continue.
The details about the license activation process are described in the Licensing page.
NOTE If network parameters have been changed, you will be automatically logged out after this screen and
will be required to log in to start a new session.
Asset creation
All asset management operations are available in the Asset Management page.
From the Dashboard, the user can access the page from the top menu Asset management. All possible operations on
assets are accessible through the page menu:
TIP
• All fields marked with an asterisk (*) are mandatory.
• Based on the selected asset type, the configuration screen will populate additional fields related to the
specific device device type (e.g. for ePDU).
• Configuring IP Address + Protocol + Credential allows you to discover automatically Asset capabilities
• Step 2: From the select area, you configure the Asset Power Source
• Step 3: (Optional) Configure "Additional Information" that are used for contextual display purpose.
TIP
Make sure you define the location of your assets and set them to Active in order to get telemetry data.
Once all the information has been input, simply click Finish and the device will appear in the Asset list.
The 3 steps wizard documented above will provide Asset edition feature.
All existing asset information will appear and the user will be able to edit the editable fields (there may be non-editable
fields, shown in grey).
Note
Notice that a configuration can be copied only to the same type of device (card/product/vendor)
running with the same firmware version.
List of elibible assets :
UPS/NMC Network-MS / Modbus-MS cards
To begin this process, go to the Asset management view, select the source asset from which you want to copy the
configuration, then click on the Configure button on top of the asset list.
The mass configuration ease the way to apply a full configuration or a part of configuration from a device to another
devices.
To configure NMC (UPS) or G3 (ePDU) cards, user can select from the source device all the settings to configure or
select them individually.
Once all settings are selected, user can choose what are the devices where he wants to apply these settings through
"BULK APPLY" function :
To configure Network M2 (UPS) cards, user can select from the source device features and not individual settings.
Once all settings are selected, user can choose what are the devices where he wants to apply these settings through
"BULK APPLY" function :
Once process is complete, IPM will notify that configuration has been applied to the devices selected.
Group Table
The screenshot here after illustrates an example with several groups displayed in the table (one group on each line).
Create button allows to create a new Group. This feature is described on next paragraph.
The table displays following information for each Group:
• Group Name
• Grouping Rule Summary is displayed in an intelligible manner
• Mouse over buttons allows to access to following features
• Edit to edit the group
• Delete to delete the group
• Info to show the Group content
Create/Edit a Group
• In Automatic Groups Tab click on Create button and following window will appear
• Enter following information :
• Group Name
• Enter a first criterion based on:
• Asset Name
• Asset HostName
• Asset IPAddress
• Asset Location
• Asset Contact
• Hosted By feature ( e.g. to retrieve the Virtual Machines Hosted By an Hypervisor )
• Operator is automatically filled (Contains or Is)
• Enter the filtering expression (Free text field or Location or Host list, ...)
• Click on Add Criteria if you want to add a second rule (the rules combine with the AND logical operator):
Groups usage
Once some groups are defined they can be used in Automation to feed the actions in a dynamic way.
When one group is defined as the target of a action, the actual group content is evaluated at the time the action is
executed.
To learn more about groups usage in Autoimation, please refer to the Automation section.
NOTE
You will need to create the device to which the sensor is connected before creating the sensor itself.
Rules for the location port numbering are provided in the asset management view documentation in "Add an
Asset" section.
Temperature & Humidity sensors (T&H) are typically mounted physically in a rack. The application requires that you
specify a rack location for the sensor. This is accomplished by selecting the Logical asset.
Once assigned to a rack, the values returned by the sensor will be used for computing the composite metrics of average
temperature and humidity for that specific rack, as well as for the row, room and data center in which the rack is
located.
The temperature and humidity values for rows are computed as averages of values of racks contained in the row. Row
averages are then propagated to the data center level.
NOTE
Make sure you define the power source for all of your assets in order to benefit from all contextual visibility and
composite metric features in the application.
Some of the fields in the section Additional Information are used for enabling contextual visibility of metrics and/or in
building the location and power chain topologies.
Once all the information has been input, you may simply press Finish and the device will appear in the asset list.
IMPORTANT NOTE
As for the ePDU in Single mode, you must enable the SNMP protocol from the Web interface of the daisy chained
ePDUs. This is mandatory to retrieve data from the ePDUs.
You must also add a SNMP v1 community ("public" is the default SNMP v1 community name) or relevent SNMP v3
credentials accessible from the Settings/Security Wallet menu.
Refer to the Security Wallet documentation for more details on credentials management.
In the IPM application, you must create a new ePDU asset with the type "EPDU" and complete fill all mandatory fields.
This operation must be completed for all of the ePDUs in the daisy chain configuration (The host device plus all devices
connected to the host).
NOTE
You must take care to ensure that the configuration defined in the application matches the configuration
defined in the ePDU daisy chain topology, see table below:
0 (Host) 1 - Host
1 (Device) 2
2 (Device) 3
3 (Device) 4
4 (Device) 5
5 (Device) 6
6 (Device) 7
7 (Device) 8
All the remaining details relating to the devices installed in the data center must be entered into the CSV file.
Once the CSV file is created, it will look like the populated sample displayed below.
CSV upload
When you are done or if you already have a CSV file, you may upload it clicking on the Choose File button which will
open a file browser in order to select your CSV file. Then click on Upload to import it in the system.
While the upload is being processed a progress indicator shows the progress of the activity.
Upload Errors
In the case an error occurs during upload, you will receive information about the line(s) that generated the error(s) and
some details regarding the error(s).
In case the case where only some CSV lines are imported successfully, you will receive a after the import which will
detail the import errors.
If the file upload is successful, you are given confirmation of the number of lines processed during the import.
Load csv was success, but error occurred during configuration sending of asset change 42 42
notification. Consult system log.
Request document has invalid syntax. Cannot detect the delimiter, use comma (,), semicolon (;) 48
or tabulator.
To exit the CSV modal click on the Close button, this will bring you to the Asset Management page.
The details submitted via CSV upload may now be viewed in the Asset Management page in a simplified spreadsheet
format.
You may edit the data center assets using the CSV file as follows:
1. Press the "Export Assets" button
2. Update the downloaded CSV file
3. Re-upload the CSV file using the "Upload CSV File" button.
• Any alarm related to the data center power chain that directly negatively impacts on redundancy should
always fall into this category
• Any alarm related to IT Network Connectivity that is directly negatively impacting business should fall
into this category
• Any alarm related to IT Systems that is directly negatively impacting business should also fall into this
category
• Any alarm related to main chillers, pumps, AHU (Air Handling Units) and CRAC (Computer Room Air
Conditioning) units that are directly impacting on the cooling of the data center and will therefore
directly impact the business
• Any alarm related to smoke alarms, fire alarms, fire suppression systems.
• Any alarm related to data center physical security systems.
• P2 (Priority 2): High Priority - Not yet impacting business but has potential to escalate quickly
• Alarms related to the data center power chain that have potential to impact redundancy soon, but are
not yet at the business critical level.
• Alarms relating to IT Network Connectivity that has potential to become a business impacting issue, but
are not yet at the business critical level.
• Alarms related to IT Systems that has potential to become a business impacting issue soon, but are not
yet at the business critical level.
• Alarms related to main chillers, pumps, AHU (Air Handling Units) and CRAC (Computer Room Air
Conditioning) units that have potential to impact on the cooling of the data center soon, but are not yet
at the business critical level.
• P3 (Priority 3): Medium Priority - Not impacting business but could become critical in the short term
• Alarms related to the Data Center power chain that will not impact redundancy immediately, but can
negatively impact on performance, and have the potential to escalate into more serious issues.
• Alarms relating to IT Network Connectivity that will not impact business immediately, but can negatively
impact on performance, and have the potential to escalate into more serious issues
• Alarms related to IT Systems that will not impact business immediately, but can negatively impact on
performance, and have the potential to escalate into more serious issues.
• Alarms related to main chillers, pumps, AHU (Air Handling Units) and CRAC (Computer Room Air
Conditioning) units that will not impact the cooling of the data center immediately, but can negatively
impact on performance, and have the potential to escalate into more serious issues.
• P4 (Priority 4): Low Priority - Not impacting business but could become critical in the long term if left
unaddressed.
• Alarms related to the Data Center power chain that will not impact redundancy immediately, but can
negatively impact on performance, and have the potential to escalate into more serious issues if ignored
long term.
• Alarms relating to IT Network Connectivity that will not impact business immediately but can negatively
impact on performance and have the potential to escalate into more serious issues if ignored long term.
• Alarms related to IT Systems that will not impact business immediately but can negatively impact on
performance and have the potential to escalate into more serious issues if ignored long term.
• Alarms related to main chillers, pumps, AHU (Air Handling Units) and CRAC (Computer Room Air
Conditioning) units that will not impact the cooling of the Data Center immediately, but can negatively
impact on performance and have the potential to escalate into more serious issues if ignored long term.
• P5 (Priority 5): Minimal Priority - Not impacting business but worth taking note of to be resolved in
futures service/maintenance intervals
• Alarms related to the Data Center power chain that are not impacting performance in any way, but will
need to be resolved during maintenance periods.
• Alarms relating to IT Network Connectivity that will not impact business or performance, but will require
resolution during prescribed downtime/maintenance periods
• Alarms related to IT Systems that will not impact business or performance, but will require resolution
during prescribed downtime/maintenance periods.
• Alarms related to main chillers, pumps, AHU (Air Handling Units) and CRAC (Computer Room Air
Conditioning) units that will not impact the cooling of the Data Center or its performance but will require
resolution during prescribed downtime/maintenance periods.
In the IPM application, you may define priority levels for each asset existing in the application. All alarms related to any
asset will inherit the priority level of the asset and they will be treated accordingly.
NOTE
Once the alarm is acknowledged and has moved into any of the acknowledged states listed, it cannot be
unacknowledged. An Acknowledged alarm can only be changed to another state of acknowledgement or
resolved.
ACK- Means that the user has acknowledged Yes No Can be un-silences
SILENCE the alarm and is taking action to resolve it. manually
The system should log the user's response
& stop sending alarms to this person and
any other person in the group. The alarms
remains visible in the system.
ACK-PAUSE Means that the user has acknowledged Yes No Can be manually un-
the alarm and is waiting for external input paused or
(user info, maintenance window, part automatically after a
delivery, ...) prior to resolving it. The specified amount of
system should log the user's response & time
stop sending alarms to this person and
any other person in the group. The alarm
remains visible in the system.
ACK-WIP Means that the user has acknowledged Yes Email or SMS sent at
the alarm and is currently classed as Work regular intervals
in Progress. The alarm remains visible in while the alarm is
the system and continues to send out still present, interval
notifications at a specified time frequency determined by
depending on the priority/severity. priority/severity
If an alarm occurs in the system and is not acknowledged, the notification must be resent until the alarm is
acknowledged and transitions into one of the states listed above.
Critical p1 5 min
p2 15 min
p3
p4
p5
Warning p1 1h
p2 4h
p3
p4
p5
Info p1 8h
p2 24h
Primary administrator
By default on the first install of IPM Editions, two user accounts are created : admin and monitor. (see default
password below).
Please note, that the built-in monitor user is deactivated by default.
This initial admin account will be automatically defined as the Primary administrator account. This means
that this account may not be edited by other user accounts with an administrator profile.
The first connection is only possible with the "admin" account created by default. The password change will
be requested on first connection.
Default passwords:
Login Password
admin admin
monitor monitor
You may change the password for both user accounts from the Settings page, in the Preferences section.
WARNING
You should be forced by the application to choose a new password at first connection.
In any case, it is strongly recommended to not keep the default passwords.
NOTE
The default password strength policy includes:
• Minimum of 8 characters
• At least 1 special character
• At least 1 digit
Please go to the Local Users section of the documentation for more details
1.6 Automation
IPM automation features allow you to create business continuity policies based on trigger events which define
appropriate action(s) to protect your IT environment : both physical and virtualized.
A wizard will assist you step by step to configure the automation policy.
You may create basic policies with simple actions like :Send an e-mail in case an alarm is generated on my device; but
automation can also trigger power actions or IT actions to protect an environment like : If a power outage is
detected on this UPS then Shutdown my hypervisor and switch off the powering ePDU outlets.
The automation wizard, enables you to configure sequences of actions.
This chapter introduces how to automate actions and notifications in the Eaton Intelligent Power Manager (IPM)
Editions application.
Note
Some feature restrictions may apply with respect to your software licence and kind of devices you are
managing.
Please check the license for more details.
Note
An automation policy can based on a single trigger event.
A trigger can be derived from one or several assets :
• in the case of a trigger event derived from a single asset : the automation policy is started when
the trigger is generated by the asset
• in the case of a trigger event derived from multiple assets : the automation policy is started
when trigger is generated by either all of the assets / or by any asset (both configuration
options are available)
An automation can also combine multiple types of trigger events. ( e.g. You can trigger an automation if a
given UPS lose the power OR if a given rack temperature is critically high)
You just have to perform following steps:
• Configure a first Trigger
• Select AND or OR as logical operator to combine the triggers
• Click on + ADD Another to configure a second trigger
An automation can also be triggered by composite devices (e.g. UPSs in parallel, ...)
For more details, here's the list of main alarms templates currently managed by the IPM application to trigger an
automation policy :
1.6.2 Actions
Once the trigger event is configured and the asset, or the group of assets generating the trigger defined, you may define
actions or a sequence of actions that you want to have applied when the automation is started.
As it is the case for the trigger events, the Automation Wizard is able to detect your configuration's capabilities and
filters the available actions with respect to your assets and licensed capabilities so you are sure to only use
authorized actions in your business continuity policy.
Actions are split into categories in the wizard to simplify the configuration :
• Shutdown Hardware - Turn on/off devices : you may control individual ePDU outlets
• Switch on/off ePDU individual outlets
• Select individual outlets
• Individual and daisy chained ePDU configurations are supported
• Power on or Power Off a physical server
• IT actions - you may configure actions to target your IT infrastructure including physical servers and
virtualized assets when virtualization connectors are configured :
• Host Power Action: this action executes a command on the targeted hypervisor.
• VM Power Action: this action executes a power command on a virtual machine.
• vApp Power Action: this action executes a power command on a virtual application.
• Cluster Actions : this action wil initiate a cluster shutdown. Cluster Configuration supported :
• VMware
• VMware HA + DRS
• VMware vSAN
• VxRail
• Nutanix
• SRM (Site Recovery Plan) : this starts a predefined recovery plan in fail-over mode. (only for VMware
connectors)
• Fault Domain Action (VMware only)
• Server IT action : execute a command on a physical serser, like Power on or Power Off
• Power capping : cap the power consumption on physical asset(s) targeted by the action
• Storage IT actions : execute the shutdown on a storage node
• SSH command
• Windows Server Shutdown
Note
For the IT actions, please note that some restrictions may apply with respect to your software licence and the
virtualization connector configured. A given action may not be valid for all connectors.
Please check the IT actions supported section below for more details.
IT actions supported
Operati
ng
systems
(Windo
ws /
Linux / .
..)
Host IT Actions
Shutdown commands
SSH
VMs IT Actions
Shutdown Guest
Suspend
Resume
Migrate
Fault Domain
Enter Maintenance mode then shutdown n/a n/a n/a n/a n/a
SRM
vApp IT actions
Shutdown
Suspend
Cluster IT Action
Servers IT Actions HP
servers
Power On
Power Off
Configurations with Critical and management VM embedded in the cluster are supported (IPM or vCenter
within the cluster)
NOTE
The product embeds a tool that can be used to extract SNMP information from devices that are not yet
supported.This tool can be used through a Secure Shell (SSH) connection.
2. Run " fty-device-scan <IP address of the device> <your email address>"
Example: fty-device-scan 192.168.0.10 john.doe@organization.com
3. Send the archive received by mail to EatonProductFeedback@eaton.com.
If possible, provide as much information on the device as possible in your mail, such as:
• the type of device, exact manufacturer and model names
• MIBs related to the device (or pointers to online versions, if available)
• any other information that you may find suitable.
Information and directions will be provided back to you shortly by mail to add support for your device.
1. Zero resilience configuration with 1 main feed powering the infrastructure directly.
2. Minimal resilience configurationwith 1 utility feed and 1 UPS protecting the critical infrastructure.
3. Minimal resilience configuration with 1 utility feed, 1 GenSet, 1 ATS and a rack mounted UPS (instead of a
standalone UPS) installed in the white space with the IT devices
4. Minimal resilience configuration with 2 utility feeds (Utility A & Utility B), an ATS and a rack mounted UPS
(instead of
a standalone UPS) installed in the white space with the IT devices
5. N configuration (Tier I) with 1 utility feed, 1 GenSet, 1 standalone UPS installed in the grey space
6. N configuration (Tier I) with 2 utility feeds (Utility A & Utility B), 1 ATS and 1 standalone UPS installed in
the grey space
7. N+1 (Tier II) Smart grid Configuration: 1 utility feed, 2 Gen Sets for additional redundancy, and 2 UPS
8. N+1 (Tier II) Smart grid Configuration: 2 utility feeds (Utility A & Utility B), 1 Gen Set for additional
redundancy, and 2 UPS
Power chain analysis algorithms implemented in IPM Editions (starting at the Manage level) are able to automatically
detect in the power chain the 3 patterns above and compute the composite power model providing two events:
• status change from "on line" to "on battery"
• low battery (based on capacity % less than a given threshold)
Those two events are usable in Automation as power events triggers as soon as the power chain configuration is
completed.
1.9 Cybersecurity
At Eaton we are focused on analyzing emerging threats and ensuring that we are developing secure products and
assisting our customers deploy and maintain our solutions in a secure environment.
We continously evaluate the cybersecurity landscape for emerging threats and provide the necessary communication
on our website as soon as possible.
Eaton strongly recommends our customers to apply the deployment practices that are outlined on our Eaton
Cybersecurity white paper Cybersecurity considerations for electrical distribution systems accessible on the Eaton
website :
Cybersecurity considerations for electrical distribution systems *
* https://www.eaton.com/us/en-us/company/news-insights/cybersecurity/white-paper-cybersecurity-considerations-
electrical-distribution-systems.html
** https://www.eaton.com/us/en-us/company/news-insights/cybersecurity/security-notifications.html
1.10 Licensing
1.10.1 Initial trial period
All IPM Editions come with one week of trial embedded.
If you skip the license activation during the setup wizard, you may begin to configure your software and commission
your assets prior to the activation of any additional license.
Note
Please note that after one week, the access to the software will be blocked and that an activation ID will be
required to connect to the software again.
During these first days a yellow notification bar will appear on top of the application to tell you how many days are left
in this initial trial mode.
At any point, you can submit a license or subscription key to activate the software for a longer duration.
To do so, click on the Activate your license link in the notification bar or navigate to Settings > License
The screen shown above illustrates the situation where an IPM Edition is connected to the internet and can perform an
online activation.
As a consequence, the checkbox Activate license online is availbale and checked by default.
If the application is not able to reach the internet, a notification is displayed to tell you that Online activation is not
available.
Type (or paste) your Activation ID into the corresponding input field and click Activate to start the activation process.
If you are in online activation mode, after you have clicked Activate you should simply wait a few seconds for the
system to display a feedback in the current page.
Note
To get access to online activation, the configuration of the proxy address to be used to access the internet
from your local network may be required. Refer to the network settings tab described in the contextual help
chapter of this document for more details on configuring the proxy.
Initial activation
Online activation will not be available for the first activation.
Only Offline activation will be allowed after a self-registration that will create an account on licensing portal.
TIP
Make sure to use the Activation ID and not the Entitlement ID from the entitlement email you received.
If you copy/paste the Activation ID into an input field, make sure to delete any preceeding or trailing spaces
that may be inadvertently copied.
c. Once connected, make sure you claimed all your Activation IDs, by using the menu Activations and
Entitlements→Claim Activation IDs , and entering your Activation ID
d. Then click on Devices from the top menu and then on Offline Device Management
e. Click on Choose File and select the capability request you generated in Step 1
f. Click on Upload. You should be notified of the license generation success.
g. Click on the "click here" link in the notification ribbon to download the generated license. This will
download a file named capabilityResponse.bin . You may now close this tab and return to the IPM
application tab in your browser.
3. The third step consists of importing the capability response file (generated at step 2.f above) into your software.
a. Click on Choose File button in the Activation Wizard.
b. Select the capability response generated during Step 2.
c. Click on Import
You should be notified about the success of the software activation process. Congratulations!
Make sure to purchase a renewal of your license early enough to avoid any disruption in your usage of IPM Editions
product.
For that matter, the application will warn you in advance about the expiration of your time delimited maintenance or
subscription products.
Pair 7 other servers to the 7 remaining 24 A server/hypervisor pair count just for
hypervisors one
Frequency (seconds) defines the Graphite data push frequency. Default value is 30.
Server IP address should be configured with the IP address of your Graphite server
Server Port is the port number to be used for your Graphite server. Default value is 2003.
Basename is the name which will be display on the Graphite server for the IPM Edition connection. If none is set, your
IPM Edition will send its hostname as the Basename.
Activate is a toggle to turn on / off the Graphite server connection. Please keep in mind that you must click Save to
start the connection between the applications.
If everything is configured correctly, the Graphite Connector Status should turn to a green Connected state
By default, Grafana will add a new panel to your dashboard. You can add additional panels using the Add panel icon :
On a new panel you may begin by either selecting the query (the data you want to see) or the visualization (the type of
graphical item you want to display).
Query
When creating a query, you must fselect the database you want to use. In this example, we select the Graphite instance
linked to the Graphana instance during the deployment of your environment.
Once you've selected the database, you then select the Series you want to display. The Series are divided into several
layers which go progressively deeper into the data center assets. You continue drilling down until you locate the data
you want to visualize.
The first part of the Series is the IPM Edition containing the asset. This is where you will find the basename that you
configured for the IPM Edition Graphite connector configuration or IPM Edition instance's hostname if you didn't
configure the basename.
Next you select the asset you want to monitor.
Due to technical limitations on the length of metric names in Graphite, your IPM Edition sends the internal identifier of
the asset instead of the name. This means that you will need to be able to find the mapping between the two in order
to configure the correct asset ID.
You may find the name of an asset ID either from performaning an export to CSV of the asset database or, alternatively
by using a REST API call to display it in a browser.
Using the REST API to display the Asset ID - Asset name mapping
From your favorite web browser, log into your IPM Editions web interface. Then, on a new tab, type https://[your_IPM
Edition_IP address_or_hostname]/api/v1/assets. You will find the list of all the assets provided by the instance of IPM
Editions including their ID, name, type and subtype.
For example, here is an example of how to get the default realpower metric for the Datacenter with the
ID datacenter-3 which is present in the IPM Edition with the basename Datacenter_01
Then you can add a second query by using the Add query button at the top right of the Query panel in order to get the
same data from another IPM Editions instance with the basename of Datacenter_02.
Now that you have your two queries, you may use them in other queries.
For instance, I can use the sumSeries function to create a sum of the power consumption from my two data centers.
Using the Text mode icon you can use the Graphite syntax istead of the Grafana UI in order to create your query
Visualization
When your queries are complete, you may change the visualization by clicking on the left vertical menu
The default visualization is Graph but you can easily change it to another type of visualization.
2 Contextual Help
Note
Passwords are case sensitive!
The factory default password security policy requires that you enter a password with at least 8
characters and that includes a minimum of 1 number, and 1 special character.
You may modify the password strength policy in the settings of the application. See User Management
for more information.
• Click Continue.
For the more details on the remaining steps in the wizard, please go to the Initial setup & configuration section of the
documentation.
Note
The Datacenter Configuration is required to get the full view. If you skipped the Datacenter
Configuration (optional) step during the initial Installation Wizard, some panels in this view will be greyed.
Just follow the link displayed in the greyed panels to complete the Datacenter Configuration and enable all
panels.
The left most Power gauge provides you with a view of the total power usage of your Data Center, allowing you to
quickly see and understand power usage at the Data Center level.
The Temperature and Humidity gauges enable you to view the current environmental status of your Data Center,
providing an aggregated value for temperature and humidity sensors deployed within your site.
The top right Active Alerts panel provides the user with visibility of the most recent active alerts occurring within their
Data Center along with timestamps and a brief description of the issue impacting a particular device.
The bottom right panel displays a Data Center uptime KPI based on the main feed to the UPS. It is a quick way to
understand the stability of the power in the data center.
Note
The Datacenter Configuration is required to get the full view. If you skipped the Datacenter
Configuration (optional) step during the initial Installation Wizard, some panels in this view will be greyed.
Just follow the link displayed in the greyed panels to complete the Datacenter Configuration and enable all
panels.
Here you are presented with a simplified line diagram of their power chain topology. You are also shown a graph of the
total power consumption of your Data Center over the last 24 hours, 1 week and 1 month. A custom date range may
also be entered manually. Active alarms are also shown on this page ensuring you will never miss any new alarms that
may occur.
If the UPS present is a stand alone 3-phase UPS, you are also able to select a high level overview of the phase balance.
A list of possible configurations for the input power infrastructure can be found in Supported Power Chain Topologies
section of the documentation.
Note
The Datacenter Configuration is required to get the full view. If you skipped the Datacenter
Configuration (optional) step during the initial Installation Wizard, some panels in this view will be greyed.
Just follow the link displayed in the greyed panels to complete the Datacenter Configuration and enable all
panels.
You are able to see detailed information for this rack including total rack power, percentage of load balance between
both rack ePDUs, and load levels on each rack ePDU. You may also view the power usage graphs over 24 hours, 7 days
and 1 month periods. The top right panel shows you the most recent alarms.
The top banner of the rack view clearly indicates the power source of each feed into the rack (E.g. UPS, Mains). See
below:
The system also displays the state of each outlet and which outlet of a rack PDU a device is connected to by simply
rolling over either a device or an outlet.
The Question Mark icon at the top right of the Rack topology provides a legend for the outlet colour:
• GREEN = Management on & device connected and within threshold
• YELLOW = Management on & device connected and above warning threshold
• RED = Management on & device connected and above critical threshold
• WHITE = Management on & no device connected
• GREY = Management off
• Grey with strike-through = Communication lost or belongs to PDU with no communication capabilities
When you perform a mouse-over on one of the outlets, the device supplied is displayed with a Bold rectanglular
highlight. If there is another outlet supplying the device, that (those) outlet(s) is (are) also displayed in bold.
When you mouse-over a rack mounted IT device in the view, a popup appears with the name of the device, the name of
the power supplies and the outlet number if the device is powered by a PDU, as well as the total power consumed by
the device from all outlets. Both device and outlets are displayed surrounded by a Bold rectanglular border.
PDU sections are represented with their name in a colored rectangle and Eaton G3/G3+ ePDUs are represented in the
rack view with the same colors as those applied to the HW unit itself making it easy to quickly identify the relevant
section and outlet.
You may mouse-over the top of the label in the colored rectangle identifiying each section. When doing so, each device
powered by the selected section's outlets is displayed with a bold border.
A tooltip is also displayed with the group name of the section, the phase powering the section and the instananeous
values of the active power, current and load % of the section.
A feed identifier is displayed above each of the rack PDU gauges. When available from the rack PDU, the feed color and
name are displayed automatically.
You may also obtain more details related to each of the rack PDUs installed. Simply click on the Details button. Details
such as serial number, installation date, warranty expiration date, etc are provided.
Clicking on the Power Monitoring tab brings you directly to this list view.
Here you may view Power devices such as UPSs, ePDUs or STS simply displayed in a list. This view is very convenient if
you didn't configure datacenter topology during initial installation wizard.
• A Search field allows you to filter the Power Devices
• You can sort the devices simply by clicking the colums headers
• On each line mouse hover buttons provide you direct access to Detailed Information or Rack View or Device
Web page
• Some metrics such as its Status, Load Level, Power Output, Battery runtime are displayed in this view
Here you may view more detailed UPS measurements such as its status, as well as the Battery, Input and Output
Metrics, while still maintaining an overview of the total critical power and active alerts.
By clicking on the Details button you are presented with further details related to the UPS such as its IP address, serial
number, location, etc.
Alternatively, you may click on the IP Address link which will take you directly to the selected UPS' embedded web
interface.
Returning to the Power View page, you may see the power consumption by rack for each rack protected by the selected
UPS.
This page is made of a main view containing several panels and a side view detailing each section, outlet by outlet, on
the right side of the page.
Note
The Datacenter Configuration is required to get the full view. If you skipped the Datacenter
Configuration (optional) step during the initial Installation Wizard, some panels in this view will be greyed.
Just follow the link displayed in the greyed panels to complete the Datacenter Configuration and enable all
panels.
Similar to the layout of the power view page, you may see the telemetry from sensor(s) monitoring the air intake (front
of rack).
You may change the selected view by selecting the grid format view on the top right of the temperature and humidity
display in order to see change from the default hierarchical view of the location topology to a grid view with all racks in
an alarm state being moved to the top of the panel in order to see them all at once.
At the top right hand side of the page, you are presented with a snap shot of your current and most recent alerts.
In the bottom right panel, you may also view graphs of the historical data related to either temperature or humidity
over the last 24hrs, 7 days or 30 days.
At all times, you have visibility of all current issues related to this device via the alarm icon which is displayed to the
left of the asset name.
Facility assets
Power asset tab will will monitor the following types of assets :
• Power Devices
• Feed
• UPS
• ATS/STS
• PDU
• ePDU
• Genset
• Sensors & GPIOs
• Sensor
• Dry contact sensor
• Output contact
Location
In the current version, it is also possible from the power asset view to create & manage:
• Location topology
• Data Center
• Room
• Row
• Rack
IT assets
From this tab, it's possible to manage assets of the following types:
• Server
• Storage
• Switch
• Router
• Rack controller
• Appliance
• Chassis
• Patch Panel
• Other
Note : IT servers related to HPE OneView connector are not monitored by IPM2
Virtual Assets
On this tab, all of the virtual assets associated to Virtualization connectors are displayed.
When a virtualization connector is correctly configured, all of the connector derived virtual assets will be displayed in
this view with high level monitoring information :
• Cluster objects :
• VMware
• VxRail
• Nutanix
• Manager objects :
• VMware vCenter
• Microsoft SCVMM
• Hypervisor objects :
• VMware : ESXi
• Microsoft Hyper-V
• Nutanix : AHV
• Virtual Machine objects :
• VMware
• Microsoft
• Nutanix
• Storage objects :
• NetApp : ONTAP
Note
Physical hosts should be created in the IT assets page prior to beginning the pairing process.
Select a hypervisor to pair and click on edit button. A dialog box will open with the list of servers available in the field
Server Host. Simply select the host on which the hypervisor is installed.
Please note that the application will not allow you to mistakenly assign more than 1 hypervisor to a host.
Auto Discovery
This menu item enables you to perform a scan of the network to discover connected power assets and to add
them automatically to the asset list. The devices elligible to the discovery are of following types:
• Uninteruptible Power Supply (UPS)
• Rack Power Device Unit (PDU)
• Automatic/Static Transfer Switch (ATS/STS)
Once the Auto Discovery menu item is selected, you are presented with the Auto Discovery initial choice.
• Click on New button to search by Single IP Address or IP Range or Netmask. Depending on the context enter
any relevant settings like IP address or range.
• To select a method, simply select the corresponding line.
• Single IP: The scan will only be performed on the individual IP address that you enter.
• IP Range: is a contiguous list of IP addresses defined by the first and the last addresses in the range. The scan
will be processed over all the IP addresses included in the range(s) defined by the user.
• Netmask: is a set of addresses defined by a base IP address and a netmask. The scan will be processed over all
the IP addresses included in the range(s) defined by the user.
Pressing the Start button will launch the configured automatic discovery process.
Simply press the Cancel button to exit the discovery modal without starting a discovery process.
The CSV upload requires a specific format. Please refer to the Asset Management documentation for more
detailed information
Before proceeding with the addition of new assets to your system, please consider the comments below:
• Create the appropriate Input Power topology for your data center. See the possible recommended
topologies available in the Supported Power Chain Topologies section in the documentation.
There is a specific Power Chain in the IPM application called the Input Power Chain. The input power
chain is made up of power devices (Feed, Genset, stand-alone UPS) which provide power to your Data
center. In order assign a device to the Input Power Chain, you simply need to set its location as data
center.
• After defining the input power chain of the data center, we recommend that you proceed to create all
rack mounted power devices (E.g. rack mounted UPSs, rack PDUs, etc.) in order to complete the power
chain down to the rack power device level.
• For adding sensors to the asset list, there is a dedicated T&H Sensors Management sub-section in the
Asset Management section of the documentation.
• For adding daisy chained rack PDUs to the asset list refer to the ePDU G3/G3+ Daisy Chaining sub-
section in the Asset Management section of the documentation.
• To enable monitoring, you must make sure you have enabled SNMP v1 or v3 protocol from the Web
interface of the devices. You will need to configure SNMP credentials in the application. Refer to the
Security Wallet section for more information.
Add Connector
To add a connector, user is redirected to settings menu / connectors
For more information please read the Settings/Connectors documentation page.
Export Assets
This button generates a CSV file that contain the description of all the configured assets.
This file will be usable to restore the asset list later if needed (see "Upload CSV file" above).
Delete Asset
This button is only active if at least one asset is selected.
When active and pressed, this button deletes all the selected assets from the list.
Depending on the way each asset has been added, its power source and location in the data center might not be set
and it may not be set to Active. This information is mandatory for an asset to be monitored by the IPM application. In
such a situation, a red alert icon (displayed below the indicator of the number of assets) will draw your attention to the
need to complete the configuration.
The link gives easy access to the Filter inactive devices dialog in order to help you focus on the assets that still need
further configuration in order to be monitored by the application.
The checkboxes in the Filter inactive devices dialog are helpful to finalize the configuration by topic (e.g. start by
completing missing power sources and then move on to missing locations, etc.).
Asset List
The main content of the asset management view is the asset list itself.
This list can be managed via the column icons and the search field:
• the list icon (on the right of the search field) enables the user to choose the columns to display in the table by
selecting the related checkboxes.
• the search field enables you to select the type of asset to display in the list
• The pagination navigation is available at the bottom of the table along with the configuration of the number of
items displayed per page (10 ; 25 or 100).
Note
Note that a configuration can be applied from one device to another if and only if they are both of the
same type (hardware/vendor) and having the same firmware revision.
Examples :
It's impossible to apply a configuration from a NMC card to a Network M2 card.
It's impossible to mass configure a NMC card to another NMC card running with a different firmware version.
Note
List of eligibles assets to Mass configuration :
UPS/NMC Network-MS / Modbus-MS cards
To begin this process, go to the Asset management view, select the source asset from which you want to copy the
configuration, then click on the Configure button on top of the asset list.
• Outlets
• Outlets groups
• Environment sensor
• EnergyWise settings
Once all / or part of settings are selected, click on the button "BULK APPLY".
Then select the asset(s) where to copy the configuration. IPM will display only the eligible assets.
Click on "APPLY" to start the configuration on targeted assets. IPM will show the progress of the configuration, and
display a message once operation is done.
With the possibility to expand the group content to display the settings of the group :
Note
For Network M2 card, it's possible to select only features and not individual settings.
For full details on features content, please refer to Network card online help or user guide.
Following features are available for the mass configuration (the list below may vary depending on the FW revision of
the Network M2 cards used):
• Account service : settings related to user management and card password management (Password strength,
Account expiration, session expiration, preferences settings, administration password)
• Card : card general information (contact, location, name)
• Certificates : certificates settings
• Date : Date & Time settings
• Email : email sending configuration
• LDAP : LDAP configuration for User management
• Measure : Meters Menu / Measure logs (logs UPS measures frequency)
• MQTT : MQTT certificates
• Network : network settings
• Power Outage Policy : protection settings / Power outage policy set on the card
• RADIUS : RADIUS configuration for User management
• Remote user : user preferences settings (temperature, language, date, time)
• Scheduled shutdown : protection settings / scheduled shutdown
• SMTP : email SMTP server settings
• SNMP : SNMP card settings
• Syslog : protocols settings / system logs
• Webserver : protocols settings / HTTPS server settings
Once one or more groups of features are selected, click on the button "BULK APPLY".
Then select the asset(s) where to copy the configuration. IPM will display only the eligible assets.
Click on "apply" to start the configuration on targeted assets. IPM will show the progress of the configuration, and
display a message once operation is done.
Automation List
All existing automations are listed in this table. From the list you may easily:
• Activate or deactivate an Automation. An automation in an Inactive state will not start if the trigger event
occurs. By default, an automation is inactive upon creation. You must manually activate it.
• Find all of the important information about each automation : Name, type of trigger event, execution
information (last start, last end, current activity, end status, and execution history)
Actions buttons found to the right of the table allow you to:
• View execution history: here you will find all the execution histories of a policy, for each execution the detail of
each stage is available as well
• Edit the automation
• Duplicate an automation
• Force start: will manually force the immediate execution of the automation as if the triggering event was just
reached
Automation Settings
The Automation settings sub-menu enables you to configure global parameters that apply to the entire automation.
From this menu, it's possible to
Manage Scripts :
It is possible to configure actions based on custom user script.
To use a script as an action, you may manage available script from here :
• Upload new scripts
• Edit existing scripts
Notifications
It is possible to configure the email address(es) to use by default when you create a Notification action. Values set here
will be retrieved automatically in the automation wizard when you configure a Notifications action.
However, it's still possible to change the mailing list during the automation configuration. In this case, the override
value will apply only to the automation where the value is changed.
• Power issue
• Scheduled time
• Other alarm
• Environmental issues
• Manual override
Note
A list of all triggering events per device that are managed by the IPM Editions software is available in the
Automation section.
Note
The Automation wizard is able to detect the application context meaning that the wizard will filter triggering
events in order to show only those that can be generated by devices discovered and monitored by the
application. Similarly, for actions the Wizard will only propose actions that are possible given your license and
virtualization connector configuration.
As a result, it is important that you've completed the setup of the application before beginning to create
your automation.
Asset based triggering events
The categories "Power issue", "Other alarm" and "Environmental issues" are all requiring the selection of source
asset(s).
For those categories, the definition of the triggering event is a 2 steps process:
1. select the nature of the event
2. select the source asset(s) of the event
When selecting multiple source assets for a given event, an option allows to define the triggering event to be true
either when the event is happening on all the source assets at the same time or at least on one of the source assets.
Example on power issue:
The first step is to define the nature of the event.
General principles
Action sequences
You may specify multiple actions, if you want to build a chained sequence of actions.
Note
In the case where you have configured multiple actions, they will be sequenced by order of configuration. In
the current version, wizard generated automation actions cannot be executed in parallel but multiple targets
can be set for a given action.
Common behaviors for all actions definition
When you've selected the action type you want to configure and the targeted asset(s) to apply the action to, the wizard
will guide you through the specifics of this action configuration. You just have to follow the process for full completion.
All action configurations are ending by the same last step about the automation behavior at the end of the execution of
each action.
You can ask the system to either check the initial trigger state at this point and, in case it would be no longer valid, stop
the action sequence right here or you can ask the system to ignore the initial trigger validity and continue whatever is
its state.
This allow to control if the sequence has to be performed entirely wathever happens after it has been triggered or if it
has to stop as soon as the initial conditions that triggered it are no longer valid.
An independant check point of the initial trigger state can also be added as an independant action.
Example 1
Once started, this sequence may only stop after Action 30 making Action 40 an optional step performed only if the
initial trigger is still true at this point.
Example 2
This second example performs the same as the first except the check point is made independant from Action 30 by
adding a specific check intial trigger action of its own. This gives more flexibility on the ordering and addition of new
steps keeping the check point at the same place (before Action 40 in the example).
Note
As in the case of triggering events, the Automation wizard is able to analyse the application context meaning
that the wizard will only propose actions that are possible given your devices, license and virtualization
connector configuration.
Note
Please note that some restrictions in available features may apply with respect to:
• your software licence
• the kind of assets configured in your IPM application
• the kind of virtualisation connector you have configured as some actions are not available in all
connectors
IT actions
Note
IT actions are enabled when virtualization connectors are configured in the IPM Editions software. Please
check the Setting view / Connectors section of the contextual help for more information.
For IT actions, please note that some restrictions may apply related to your software licence and the type of
virtualization connector you have configured as some actions aren't available in all connectors.
Please check the chapter Automation / IT actions supported in the General Information section in the
documentation for more details.
Using IT actions, you may configure actions applicable to virtual hosts and machines monitored via a virtualization
connector. In addition to actions on virtual assets, the IT sections also covers the actions aplicable to some physical
servers either discovered by a 3rd party connector (e.g. connector to HPE OneView) or directly reachable by SSH
protocol.
Actions are grouped by sub-categories:
• vAPP action: These actions apply to some targeted virtual app(s)
• power on
• suspend
• shutdown
• VM action: These actions apply to some targeted virtual machine(s)
• powerOn
• powerOff
• shutdownGuest
• shutdownGuestWithTimeout
• suspend
• resume
• migrate
A valid SMTP server must be configured for the Send message action to work properly.
Please proceed to the configuration of the SMTP server to be used in Settings/Notifications page.
Note
The IPM Editions software embeds appropriate tools to support the following scripting languages:
• Bash, Python, Perl as part of the system
• IPMI, Redfish, Wake On Lan, Expect using additional libraries
Dynamic Groups
On some Power and IT actions, you have the possibility to select a dynamic group as the target of the Action.
A Toggle choice allows you to select between Static and Dynamic asset selection.
If the group has been already created it appears automatically in the list (refer to Asset Management page of the User
Manual to create Dynamic Groups).
You can also create a new Dynamic Group on the fly with the Create new dynamic group button.
It provides you with application information and real-time metrics related to aplication health (E.g. storage usage,
uptime, memory usage, cpu usage, and network usage).
It also allows to download and archive following logs for troubleshooting purpose:
• Maintenance
and
• System Logs
The Account settings feature is accessible from the right hand icon in the Top bar.
Note: Your password, can also be changed from the right hand icon in the Top bar.
Although the temperature and humidity settings have default values, you may adjust them to a more suitable setting
reflective of the standards you have defined for your data center environment
All alarms can be set to send additional notifications to specified users by email, email to SMS gateway or both.
On the UPS alarm settings page, you have the capability to set thresholds for UPS alarm management. These
thresholds are set locally on the IPM instance.
The user can set certain thresholds at once for multiple UPSs.
To do so:
• Select the target devices,
• Click on Change UPS thresholds
• Enter the details in the text fields
• Click on the Apply now to all UPS button.
100 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
On the Row alarm setting page, you have the capability of setting thresholds for alarm management for rows in your
data center. The thresholds are set locally in the IPM application.
It is possible to change following thresholds:
• Temperature.
• Humidity.
You may set specific thresholds at once for multiple rows.
To do so:
• Select the target rows,
• Click on Change Row thresholds
• Enter the details in the text fields
• Click on the Apply now to all Rows button
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 101
Setting Views
102 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
You may set specific thresholds at once for multiple target rack PDUs.
To do so:
• Select the target rack PDU,
• Click on Change PDU thresholds,
• Enter the details in the text fields ,
• Click on the Apply now to all selected PDUs button.
2.13.3 Connectors
The Connectors settings tab is accessible from the Settings menu item in the left navigation menu.
Overview
The IPM application can monitor and orchestrate business continuity policy when virtualization connectors are used.
This feature enables the IPM application to manage and interact with your third party products or your virtualized IT
environment.
IPM can be configured to use the following connectors:
• Virtualization:
• VMware vCenter
• VMware ESXi
• Microsoft HyperV / Server
• Microsoft SCVMM
• Nutanix Prism Central / Cluster
• Dell EMC - VxRail
• Server:
• Microsoft Windows Server
• HPE OneView
• Storage:
• NetAPP
Once a connector is properly configured, all assets managed by the connector are retrieved by IPM2 in an asset
management page (Assets menu / virtual Assets tab) : Virtual machines, Hypervisor, Manager, VMs, Cluster.
Connectors also enable the IPM application to interact with the assets monitored by the connectors and for you to
define business continuity policies using the IPM automation features.
Note
The virtualization connectors and IT actions supported per connector are detailled in the IPM Documentation
section Automation / IT actions supported
Please note that some restrictions may apply with respect to your software licence and type of virtualisation
connector configured as some actions are not avaiable on all connectors.
Add new connector
Click on ADD CONNECTOR and select the type of connector you want to configure : Virtualization, Storage or Server
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 103
Setting Views
Delete connector
To delete a connector, select it from the the list and then click on DELETE CONNECTOR.
The connector and all assets discovered via the connector will be automatically removed.
104 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
If you did not configure Datacenter Layout during initial installation wizard, the button Enable Datacenter layout
allows to unlock Datacenter Layout configuration for advanced Power and Spatial views.
If you click on the Enable Datacenter layout button it will not be possible to come back later to ths simple Device
Centric mode.
Once you have enabled Datacenter Layout, you can create data center layout topology : rooms, rows, racks.
Data center topology objects are currently also created and managed from the Asset Management page.
Nevertheless, the application offers a separate visual tool for streamlining the creation of the assets used in building
the data center layout topology : rooms, rows, racks.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 105
Setting Views
Any data center must have at minimum a room containing a row with a rack inside.
Additional rooms, rows and racks may be defined. None of the existing assets can be edited in this page, but only
completely removed.
For all the new assets added, you may change the default name before the configuration is saved. Once saved, edit
operations may only be performed from the Asset Management page.
Once the full layout has been defined, simply click Save. All new assets are visible now in the Asset management page.
NOTE
If you want to remove a Room, Row or Rack, all child object must first be removed (e.g. all devices deleted from the
rack before deleting the rack)
Attention
Some compatibility issues have been observed with some NTP servers based on MS-Windows OS.
If any issues are encountered, it's advised to use Manual time settings or to configure another NTP server.
2.13.6 License
The License settings tab is accessible from the Settings menu item in the left navigation menu.
The License settings displays the license status and details of your IPM application.
106 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
All information regarding the features that your instance of IPM application is entitled to use as well as relevent
expiration dates are displayed here.
IPM Editions come with a one week initial trial License. Longer duration trial licenses are also available on request.
Other licenses may be purchased and require activation.
To activate a license, click on the Activate license button which will take you to the activation wizard modal.
Information detailing license activation may be found in the Licensing subsection of the General Information section.
2.13.7 Monitoring
The Monitoring settings tab is accessible from the Settings menu item in the left navigation menu. This includes
Graphite/Grafana connector settings and SNMP polling interval configuration. The SNMP credentials are set in the
Security Wallet.
SNMP
You may add SNMP v1 community names and/or SNMP v3 credentials. See the Security Wallet section for more
information on SNMP credential configuration.
The SNMP polling interval may be configured in this view. The default polling rate is 30 seconds.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 107
Setting Views
Prerequisite
A graphite database server must be up, running and accessible for IPM to use this feature. IPM will act as a
data provider to your existing server (The Graphite and Grafana servers are not embeded in the IPM OVA
image).
Prerequisite
An IPM Graphite Plug-In license is required to unlock this feature.
Please see the General information > Graphite / Graphana deployment section of the documentation for more detailed
information on setting up a Grafana environment.
Frequency (seconds) defines the Graphite data push frequency. Default value is 30.
Server IP address should be configured with the IP address of your Graphite server
Server Port is the port number to be used for your Graphite server. Default value is 2003.
Basename is the name which will be display on the Graphite server for the IPM Edition connection. If none is set, your
IPM Edition will send its hostname as the Basename.
Activate is a toggle to turn on / off the Graphite server connection. Please keep in mind that you must click Save to
start the connection between the applications.
If everything is configured correctly, the Graphite Connector Status should turn to a green Connected state
108 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 109
Setting Views
The security wallet is represented as a list of credentials which may be sorted by clicking on any column.
A search engine is also available to quickly select a specific credential by typing all or a part of its name.
Once a security wallet item is selected, it may be either modified or deleted using the corresponding action button at
the top of the panel.
110 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 111
Setting Views
Delete a credential
1. Select one or several credentials from the list
2. The Delete button will become active
3. Click on the Delete button. You will be presented with a modal dialog which will request your password.
4. Enter your Password
5. Click on Confirm
112 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
2.13.10 Notifications
Email notifications require an accessible SMTP server to be configured and a sender email address to be entered.
To test the configuration, the Test Email field can be used to enter a recipient for the test.
If you have an SMS gateway, configure it in the SMS Gateway field to also receive SMS notifications.
The Save button on the bottom right corners persists the configuration into the system.
Sending emails through Microsoft 365 or Office 365 requires some server side configuration. The following
article might help in this process:
https://docs.microsoft.com/en-us/exchange/mail-flow-best-practices/how-to-set-up-a-multifunction-device-
or-application-to-send-email-using-microsoft-365-or-office-365
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 113
Setting Views
Upgrade Software
The top panel is dedicated to the IPM software upgrade process.
It provides a view on the IPM software versions you have downloaded in addition to the version that is currently
running.
Initially, the view presents the active version only (the one currently running).
Newer versions of IPM can be downloaded from our website.
When it is downloaded, it can be added to the system by clicking on "Import" and browsing to the dowloaded local
copy of the package.
An unused version can be removed from the system by selecting it and clicking on "Delete" button.
To upgrade your IPM software:
1. Download the latest upgrade package from powerquality.eaton.com
2. Import it into the system using the Import button
3. Once imported, select it and click on the Activate button
Warning
Downgrade is not currently supported. Use this feature to switch only to newer versions of IPM.
114 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
Upgrade Devices
The bottom panel is dedicated to firmware upgrades for Eaton communication cards that IPM is managing:
• Eaton Gigabit Network Card firmware can be downloaded at powerquality.eaton.com
• Eaton G3 ePDU Network Management and Control Module (eNMC) firmware can be
downloaded at powerquality.eaton.com
• Eaton Network Mangement Card (NMC) firmware can be downloaded at powerquality.eaton.com
Once a firmware package has been dowloaded, it maybe imported into the system by clicking on the Import button,
then selecting the package with the file browser.
Once imported into the system, it appears in the firmware repository list and it may be selected.
At this point, click on the Upgrade button to start the firmware upgrade process.
Only users with an admin profile have permission to access to this settings menu.
Administrators may create a new account, edit, delete, and activate / deactivate existing accounts.
Primary administrator
By default on the first install of IPM Editions, two user accounts are created : admin and monitor. (see default
password below)
This initial admin account will be automatically defined as the Primary administrator account. This means
that this account may not be edited by other user accounts with an administrator profile.
The first connection is only possible with the "admin" account created by default. The password change will
be requested on first connection.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 115
Setting Views
The table shows all the supported local user accounts and includes the following details:
• Username
• Email
• Profile
• Status – Status could take following values – Inactive/Locked/Password expired/Active
Actions
Add
Press the New button to create up to ten new users.
When completed:
116 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
Remove
Select a user and press the Delete button to remove it.
Edit
Press the pen icon to edit user information:
• User Details
• Active: allows to activate or deactivate account
• Profile: administrator or viewer
• Username: this value will be used as login ID
• Full name
• Email
• Phone
• Organization – Notify by email about account modification/Password
• Reset password
• Generate randomly: the system will automatically create a random password
• Enter manually: you create your own password, taking care to respect the parameters defined in
password strength policy
Note: The new user will be required to change his password upon his/her first connexion.
• Confirmation Password: In order to finalize the user account creation, the administrator currently
logged into the application has to reauthenticate by entering his/her own password. The Save button
will be activated only after this has been completed. A similar reauthentication behavior is required to
reset a user account password. Same behaviour when an administrator wants to reset a user account
password.
• Lock account information
• Password expiration information
Security policy configuration changes apply to all accounts created in your IPM application.
For a more detailed explanation of User settings configuration, see the User Management section of the
documentation.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 117
Setting Views
118 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
Account timeout
To set the session expiration rules, apply the following restrictions:
• No activity timeout (in minutes).
If there is no activity, session expires after the specified amount of time.
• Session lease time (in minutes).
Session still expires after the specified amount of time.
Configure action
1. Press Configure to access the following LDAP settings:
• Primary server
• Name
• Hostname
• Port
• Secondary server
• Name
• Hostname
• Port
• Credentials
• Anonymous search bind
• Search user DN
• Password
• Request parameters
• User base DN
• User name attribute
• Group base DN
• Group name attribute
2. Click Save.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 119
Setting Views
Each configured server will appear in the below table with the following details:
• Name
• Address
• Port
• Security
• Certificate
• Status
120 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
Profile mapping
The feature is about mapping remote groups to local profiles.
Users preferences
User preferences are common to all users authenticated through LDAP.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 121
Setting Views
1. Press Users preferences to define preferences that will apply to all LDAP users
• Language
• Temperature
• Date format
• Time format
2. Click Save.
122 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Setting Views
In addition to the list of categories, the user must provide a passphrase to encrypt the sensitive data that might be
present in the saved file.
In order to help the selection of the appropriate categories some detail can displayed for each category by hitting the
control present at the end of each category line.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 123
Setting Views
Once the selection of the settings categories is done and the passphrase is typed and confirmed, the user can proceed
and Save the selected settings.
The user will have to provide the chosen passphrase to restore all or part of the saved settings later.
Therefore, this passphrase must be chosen and noted carefully.
124 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Alarms View
The categories can be restored independently and the user is free to select all or some of them.
Once the selection of the settings categories is done and the passphrase entered at Save time is typed again, the user
can proceed and restore the selected settings.
You may view and manage the state of all alarms from the Alarms view page.
By default, you are presented with all current active alarms in the system.
Each alarm displays the system name generating the fault condition, a timestamp of when the alarm occurred, and a
short description of the alarm taking place.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 125
Feedback Tool
Users may place Alarms into one of several possible states enabling you to move the alarm through your internal
workflow and take appropriate action when addressing an incident.
All alarm states may be filtered by using of the Filter function at the top of the page.
Filter attributes include :
1. Asset Type
2. Severity
3. Status
4. Priority
5. Name
Refer to the Alarms Management section of the documentation for a more detailed description of the management
features.
The Feedback tool allows you to communicate questions or comments directly to Eaton.
126 - Contextual Help IPM Editions User Guide Rev 2.3.0 05/27/2021
Feedback Tool
1. Select the appropriate radio button with respect to the type of feedback you are providing :
a. General feedback about the IPM application
b. Relative to the current page
2. In the Comment field, please try to describe all the details of the issue you want to report. Please provide us
with any relevant information about the context in which you are using your IPM application.
3. If you'd like us to reply to your submission, please enter a reply email address.
4. You may optionally add a file (e.g. screenshot) that can complement your text description by clicking on
Choose File and selecting a file from the file browser.
5. Click Send.
It is also possible to manually send an email to EATON support at this address: EatonProductFeedback@Eaton.com
IPM Editions User Guide Rev 2.3.0 05/27/2021 Contextual Help - 127
Connector connections
3 Troubleshooting
4.1 How can I get the right license to move from IPM Infrastructure to IPM
Understand Edition?
In case you purchased an IPM Infrastructure license, please contact your local sales representative to retrieve a license
for IPM Understand Edition.
4.2 How can I migrate my configuration from IPM Infrastructure 1.5 to IPM
Understand Edition?
The migration from IPM Infrastructure 1.5 to IPM Understand Edition is limited to the asset list. The rest of the settings
have to be set manually on the new instance of IPM Understand Edition.
132 - Appendix I - Migrating from IPM Infrastructure 1.5 to IPM IPM Editions User Guide Rev 2.3.0 05/27/2021
Introduction
5.1 Introduction
In this section we will give you some example of payload which you will find in the saved file from Save and Restore
feature.
In case you would have multiple instances of IPM Editions and you would like to configure all of them in a similar
way, one approach is:
• to configure a first instance via the intuitive IPM Editions user interface
• to save your configuration to a file
• to customize the file to adapt it to the other instances
• to force the restoration of the modified files into the target instances
This section apply only to save files generated with version 2.3.0 of IPM Editions
The file is in Json format. In this document we are describing partial json by adding "...".
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 133
File global structure
{
"checksum": "d903bk/69h4yMv3zwO56+A==:wQalNg4XBCT2/3E1sVG1eQ==",
"status": "success",
"version": "2.1",
"data": [
{
"group_name": "group-assets",
"group_id": "group-assets",
"features": [ ... ],
"data_integrity": "1f7a23e0f86448b5e7b7b8234e630bbad61411f1141546908ccbc647621c0d70"
},
....
Example of a feature
"automations": {
"status": "success",
"version": "1.0",
"error": "",
"data": {...}
}
134 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
List of groups and features
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 135
"Asset management" (group-assets)
"asset-agent": {
"status": "success",
"version": "1.0",
"error": "",
"data": {
"version": "1.0",
"data": [
{...},
{...}
136 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
"priority": 5,
"tag": "",
"ext": {
"endpoint.1.protocol": {
"readOnly": false,
"value": "nut_snmp"
},
"endpoint.1.nut_snmp.secw_credential_id": {
"readOnly": false,
"value": "b4e60d7e-dd0c-4515-94cc-791242dd51ae"
},
"endpoint.1.port": {
"readOnly": false,
"value": "161"
},
"name": {
"readOnly": false,
},
"ip.1": {
"readOnly": false,
"value": "10.130.35.81"
},
....
},
"id_secondary": "",
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 137
"Asset management" (group-assets)
"status": 2,
"subtype": "ups",
"parent": "",
"id": "ups-89890588",
"type": "device"
{ {
"priority": 5, "priority": 5,
"ext": { "ext": {
"name": { "name": {
}, },
.... ....
} }
138 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
{ {
"priority": 5, "priority": 5,
"ext": { "ext": {
"endpoint.1.protocol": { "endpoint.1.protocol": {
}, },
"endpoint.1.nut_snmp.secw_credential_id": { "endpoint.1.nut_snmp.secw_credential_id": {
}, },
"endpoint.1.port": { "endpoint.1.port": {
}, },
"ip.1": { "ip.1": {
}, },
.... ....
}, },
"status": 2, "status": 2,
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 139
"Asset management" (group-assets)
} }
"automations": {
"version": "1.0",
"status": "success",
"error": "",
"data": {
"bundleVersion": "2.3.14",
"automationList": [
{...},
{...}
140 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
"comments": "",
"createdBy": "admin",
"active": false,
"schedule": "",
"initialTrigger": "{0}",
"triggerType": "CAT_OTHER",
"triggers": {
"ipmInfraEvent": [],
"metricEvents": [
"index": 0,
"asset": "rackcontroller-0",
"metric": "uptime@rackcontroller-0",
"operation": ">",
"threshold": "107428"
},
"tasks": [{
"index": 0,
"group": "WAIT",
"subgroup": "DELAY",
"properties": [{
"key": "duration",
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 141
"Asset management" (group-assets)
}],
"timeout": 3600,
"onSuccess": null,
"onFailure": null
}],
"notification": {
"notifyOnFailure": false,
"emails": []
Warnings
• Automation name must be unique amongst all IPM Edition automations.
• Automation name must NOT be null or empty.
• Automation comment could be null or empty
Example
Payload without modification Updated payload
{ {
"name": "My old automation name", "name": "My new automation name",
... ...
} }
142 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
Warnings
• Automation task name must NOT be null or empty.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 143
"Asset management" (group-assets)
Example
Payload without modification Updated payload
{ {
"tasks": [{ "tasks": [{
"index": 0, "index": 0,
"properties": [{ "properties": [{
}], }],
}], }],
"notification": { "notification": {
"emails": [] "emails": []
} }
} }
144 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
Warnings
• Property value could NOT be null or empty.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 145
"Asset management" (group-assets)
Example
{ { {
}, }, },
146 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
"value": ["powerOff"] }, { }, {
"value": [] }, { "vm-125-…075b",
}] }} "onSuccess": null,
}} "onFailure": null
}]
}}
The first payload (1st column) represents the original payload with action on automatic group 5.
The second one is modified on automatic group from 5 to 2.
The third one is now on some virtual machine assets but not on automatic group anymore.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 147
"Asset management" (group-assets)
Example
{ {
"triggers": { "triggers": {
"ipmInfraEvent": [{ "ipmInfraEvent": [{
"index": 0, "index": 0,
"templateName": "templateName":
"input_voltage_low@__name__.rule", "input_voltage_low@__name__.rule",
"assets": [ "assets": [
"ups-23" "ups-42"
], ],
... ...
} }
This is to change a trigger source (here, the one of trigger index 0) from asset “ups-23” to asset “ups-42” in
ipmInfraEvent case.
Below is the equivalent in the metricEvents case.
148 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
{ {
"triggers": { "triggers": {
"metricEvents": [ "metricEvents": [
{ {
"index": 0, "index": 0,
"assets": [ "assets": [
"ups-59489058" "ups-2256789"
], ],
... ...
} }
5.4.3
Customize Connectors in a file saved by IPM Editions
Introduction
Virtual assets are saved into the json object called “virtual-assets” and inside this object the assets are represented
generically under two main json objects:
"assetList" : which holds the identifier and type infos of virtual assets.
"assetAttributes": which holds their attributes.
Note that the only virtual assets that are configurable in this json are connectors, when a connector is well configured,
all the other virtual assets (Clusters, Hypervisors, vApps, VMs, etc.) are automatically discovered by IPM.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 149
"Asset management" (group-assets)
Warnings
• Make sure the attribute linked asset is the corresponding connector that you want to modify.
• Both hostname and IP Address of the connector are accepted.
• the value field cannot be null or empty and should follow the RFC 3986 - Uniform Resource Identifier (URI)
standard.
150 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
"Asset management" (group-assets)
Example
Warnings
• Make sure the attribute linked asset is the corresponding connector that you want to modify.
• the value field cannot be null or empty and should follow the following format:
"login::<USERNAME>|password::<PASSWORD>|adaptorType::<ADAPTOR>".
• Do NOT modify the adaptorType.
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix II - Save and Restore file - 151
"Asset management" (group-assets)
Example
152 - Appendix II - Save and Restore file IPM Editions User Guide Rev 2.3.0 05/27/2021
Introduction
6.1 Introduction
IPM Editions comes with some commands one can use in a shell console or inside scripts.
This allow to interact with the system without starting the graphical user interface and to streamline some processes
one would like to automate.
The commands are accessible using the hypervisor console or using ssh on the port 22 or 4222.
Syntax
$ /usr/share/fty/scripts/license-agreement.sh -h
Usage: license-agreement.sh [options...]
--host|-h <hostname> (default: 'localhost')
--port|-p <port> (default: '443')
--user|-u <username> (default: connected user 'admin')
--ntry|-n <number-of-tries> (default: 3, min: 1)
--help
6.2.2 license-activation.sh
Description
This command allows to do a online activation of a licensing id. You must be registered on licensing portal before to be
able to do online activation. An internet connect is required and a proxy could be needed.
Syntax
$ /usr/share/fty/scripts/etn-license-activation.sh -h
Usage: etn-license-activation.sh [options...] <command>
Commands:
IPM Editions User Guide Rev 2.3.0 05/27/2021 Appendix III - Using the command line interface (CLI) - 153
List of available commands
test_online
activate_online [options...]
--id|-i <activationID>
--help|-h
6.2.3 fty-srr-cmd
Description
This command allows to use Save and Restore in command line. I can be use to do mass configuration using a restore
file as template.
Syntax
$ /usr/bin/fty-srr-cmd
Usage: fty-srr-cmd <list|save|restore|reset> [options]
-h, --help Show this help
-p, --passphrase Passphrase to save/restore groups
-pwd, --password Password to restore groups (reauthentication)
-t, --token Session token to save/restore groups if needed [default:
1Hvq2h89t5TslTAgXuWbDzRy]
-g, --groups Select groups to save (default to all groups)
-f, --file Path to the JSON file to save/restore. If not specified, standard
input/output is used
-F, --force Force restore (discards data integrity check)
Example to save to a file in /tmp/my-save.json
$ fty-srr-cmd save -p myPassphrase -f /tmp/my-save.json
### - No group option specified
Saving all groups
### Groups available:
- group-assets
- group-discovery
- group-mass-management
- group-monitoring-feature-name
- group-network
- group-notification-feature-name
- group-user-session-management
Request status: success
Example to restore from a file stored in /tmp/my-restore.json
$ fty-srr-cmd restore -p myPassphrase -pwd myLogginPassord -f /tmp/my-
restore.json
154 - Appendix III - Using the command line interface (CLI) IPM Editions User Guide Rev 2.3.0 05/27/2021