=head1 B B - remote energy management tool =head1 B B [-h | --help] B [-v | --version] B B noderange [-V] { all | { [savingstatus] [cappingstatus] [cappingmaxmin] [cappingvalue] [cappingsoftmin] [averageAC] [averageDC] [ambienttemp] [exhausttemp] [CPUspeed] } } B noderange [-V] { {savingstatus}={on | off} | {cappingstatus}={on | off} | {cappingwatt}=watt | {cappingperc}=percentage } B B noderange [-V] { all | { [savingstatus] [dsavingstatus] [cappingstatus] [cappingmaxmin] [cappingvalue] [cappingsoftmin] [averageAC] [averageDC] [ambienttemp] [exhausttemp] [CPUspeed] [syssbpower] [sysIPLtime] } } B noderange [-V] { {savingstatus}={on | off} | {dsavingstatus}={on-norm | on-maxp | off} | {cappingstatus}={on | off} | {cappingwatt}=watt | {cappingperc}=percentage } =head1 B This B command can be used to manage the energy consumption of IBM servers which support IBM EnergyScale technology. Through this command, user can query and set the power saving and power capping status, also can query the average consumed energy, the ambient and exhaust temperature, the processor frequency for a server. B command supports IBM POWER6 and POWER7 rack-mounted servers. Currently, following specific hardware types are supported: I<8203-E4A>, I<8204-E8A>, I<9125-F2A>, I<8233-E8B>, I<8236-E8C>. The parameter I needs to be specified for B command to get the target server. The I should be a list of CEC names. Lpar name is not acceptable here. B command can accept multiple of energy attributes to query or one of energy attribute to set. If only the attribute name is specified, without the '=', B gets and displays the current value. Otherwise, if specifying the attribute with '=' like 'savingstatus=on', B will turn on the static power saving. The attributes listed in the B section are which ones can be handled by B command. But for each specific type of server, there are some attributes are not supported. If user specifies an attribute which does not be supported by certain server, the return value of this attribute will be 'na'. The supported attributes for each specific hardware types are listed at following: 8203-E4A, 8204-E8A Supported attributes: B: savingstatus,cappingstatus,cappingmin,cappingmax,cappingvalue, cappingsoftmin,averageAC,averageDC,ambienttemp,exhausttemp,CPUspeed B: savingstatus,cappingstatus,cappingwatt,cappingperc 9125-F2A Supported attributes: B: savingstatus,averageAC,ambienttemp,exhausttemp,CPUspeed B: savingstatus 8233-E8B, 8236-E8C Supported attributes: B: savingstatus,dsavingstatus,cappingstatus,cappingmin,cappingmax, cappingvalue,cappingsoftmin,averageAC,averageDC,ambienttemp,exhausttemp, CPUspeed,syssbpower,sysIPLtime B: savingstatus,dsavingstatus,cappingstatus,cappingwatt,cappingperc Note: Each query operation for attribute CPUspeed, averageAC or averageDC needs about 30 seconds to complete. The query for others attributes will get response immediately. =head1 B B command depends on a CIM client tool B to communicate with server. Then, before running the B command, please check whether the B package has been installed. B can be downloaded from IBM web site. =head1 B -h | --help Display the usage message. -v | --version Display the version information. -V Verbose output. B Query all energy attributes which supported by the specific type of hardware. savingstatus Query the static power saving status. The result should be 'on' or 'off'. 'on' - enable; 'off' - disable. savingstatus={on | off} Set the static power saving. The value must be 'on' or 'off'. If turning on the static power saving, the processor frequency and voltage will be dropped to a fixed value to save energy. The savingstatus setting operation needs about 2 minutes to take effect. (The used time depends on the hardware type) dsavingstatus Query the dynamic power saving status. The result should be 'on-norm', 'on-maxp' or 'off'. If turning on the dynamic power saving, the processor frequency and voltage will be dropped dynamically based on the core utilization. It supports two modes for turn on state: I - means normal, the processor frequency cannot exceed the nominal value; I - means maximum performance, the processor frequency can exceed the nominal value. dsavingstatus={on-norm | on-maxp | off} Set the dynamic power saving. The value must be 'on-norm', 'on-maxp' or 'off'. The dsavingstatus setting operation needs about 2 minutes to take effect. (The used time depends on the hardware type) cappingstatus Query the power capping status. The result should be 'on' or 'off'. cappingstatus={on | off} Set the power capping status. The value must be 'on' or 'off'. This is the switch to turn on or turn off the power capping function. cappingwatt=watt Set the power capping value base on the watt unit. If the 'watt' > maximum of I or 'watt' < minimum of I, the setting operation will be failed. cappingperc=percentage Set the power capping value base on the percentage of the max-min of capping value which getting from I attribute. The valid value must be from 0 to 100. cappingmaxmin Query the maximum and minimum of power capping value which can be set for a CEC. (Unit is watt) cappingvalue Query the current power capping value. (Unit is watt) cappingsoftmin Query the minimum value that can be assigned to power capping without guaranteed enforceability. (Unit is watt) averageAC Query the average power consumed (Input). (Unit is watt) Note: For 9125-F2A server, the value of attribute averageAC is the aggregate for all of the servers in a rack. averageDC Query the average power consumed (Output). (Unit is watt) ambienttemp Query the current ambient temperature. (Unit is centigrade) exhausttemp Query the current exhaust temperature. (Unit is centigrade) CPUspeed Query the effective processor frequency. (Unit is MHz) syssbpower Query the system power consumed prior to power on. (Unit is MHz) sysIPLtime Query the time used from FSP standby to OS standby. (Unit is Second) =head1 B 0 The command completed successfully. 1 An error has occurred. =head1 B 1. Query all the attributes which CEC1,CEC2 supported. B CEC1,CEC2 all The output of the query operation: CEC1: savingstatus: off CEC1: dsavingstatus: off CEC1: cappingstatus: off CEC1: cappingmin: 1953 W CEC1: cappingmax: 2358 W CEC1: cappingvalue: 2000 W CEC1: cappingsoftmin: 304 W CEC1: averageAC: na CEC1: averageDC: na CEC1: ambienttemp: na CEC1: exhausttemp: na CEC1: CPUspeed: na CEC1: syssbpower: 40 W CEC1: sysIPLtime: 900 S CEC2: savingstatus: off CEC2: cappingstatus: off CEC2: cappingmin: 955 W CEC2: cappingmax: 1093 W CEC2: cappingvalue: 1000 W CEC2: cappingsoftmin: 226 W CEC2: averageAC: 627 W CEC2: averageDC: 531 W CEC2: ambienttemp: 25 C CEC2: exhausttemp: 40 C CEC2: CPUspeed: 4695 MHz 2. Query the attributes savingstatus, cappingstatus and CPUspeed for server CEC1. B CEC1 savingstatus cappingstatus CPUspeed The output of the query operation: CEC1: savingstatus: off CEC1: cappingstatus: on CEC1: CPUspeed: 3621 MHz 3. Turn on the power saving function of CEC1. B CEC1 savingstatus=on The output of the setting operation: CEC1: Set savingstatus succeeded. CEC1: This setting may need some minutes to take effect. 4. Set the power capping value base on the percentage of the max-min capping value. Here, set it to 50%. B CEC1 cappingperc=50 If the maximum capping value of the CEC1 is 850w, and the minimum capping value of the CEC1 is 782w, the Power Capping value will be set as ((850-782)*50% + 782) = 816w. The output of the setting operation: CEC1: Set cappingperc succeeded. CEC1: cappingvalue: 816 =head1 B /opt/xcat/bin/renergy