The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
DomainMember# configure terminal DomainMember(config)# interface gigabitethernet 0/1 DomainMember(config-if)# energywise name PC-1 DomainMember(config-if)# end DomainMember(config)# end DomainMember# energywise query importance 100 name PC-1 wol mac <mac-address>
DomainMember(config-time-range)# periodic weekday 9:30 to 11:30and
DomainMember(config-time-range)# periodic weekday 10:30 to 12:30The switch hibernates from 9:30 a.m. to 11:30 a.m. The second periodic condition is disregarded because the switch will already be in hibernation.
Warning |
Voice over IP (VoIP) service and the emergency calling service do not function if power fails or is disrupted. After power is restored, you might have to reset or reconfigure equipment to regain access to VoIP and the emergency calling service. In the USA, this emergency number is 911. You need to be aware of the emergency number in your country. Statement 361. |
The system does not perform activity check before hibernating (scheduled or immediate hibernation). This means that the switch configured to hibernate at a certain time will do so even if a PoE port on the switch is sending or receiving traffic.
Information About Configuring EnergyWise
In a network, Cisco EnergyWise monitors and manages the power usage of network devices and devices connected to the network.
Domain members and endpoints receive power from an AC or DC power source or a power supply.
PoE domain members and endpoints also receive power from PoE switches or Cisco EtherSwitch service modules. For example, IP phones and access points connected to a PoE switch receive power from the switch.
A Cisco EnergyWise domain is considered to be one unit of power management. The domain consists of Cisco networking devices, Power over Ethernet (PoE) endpoints, and endpoints running agents that are built using the software development kit (SDK) library. This domain is similar to a network-management community such as a VLAN Trunking Protocol (VTP) domain.
For example, if you have a building with a core router, 10 access switches, and 400 endpoints, such as phones, access points, and PCs, you can create an EnergyWise domain called MyBuilding with the router and switches as domain members.
If you want to implement power management applications on a management station and endpoints, all the domain members must run Cisco EnergyWise Version 2.6 or later.
After you enable and configure EnergyWise on the core router and access switches, the MyBuilding domain configures itself. Neighbor relationships are set among the domain members.
Each domain member sets up a parent-child relationship with an attached endpoint. For example, an IP phone (child) is connected to a PoE switch (parent), or a PC (child) is connected to a router (parent).
After the domain is set, a domain member can forward queries and control messages to other domain members and endpoints. You can do the following:
Cisco EnergyWise uses a set of power levels to consistently manage power usage. A power level is a measure of the energy consumed by devices in an EnergyWise network.
Category |
Level |
Description |
---|---|---|
Operational |
10 |
Full |
Operational |
9 |
High |
Operational |
8 |
Reduced |
Standby |
7 |
Medium |
Standby |
6 |
Frugal |
Standby |
5 |
Low |
Standby |
4 |
Ready |
Standby |
3 |
Standby |
Nonoperational |
2 |
Sleep |
Nonoperational |
1 |
Hibernate |
Nonoperational |
0 |
Shut |
The devices in an EnergyWise network can be from different manufacturers.
Note |
A Cisco switch does not support level 0. You cannot turn off the power on a switch. |
A PoE endpoint, such as an IP phone, receives power from a PoE switch port. The following are the PoE endpoint power characteristics:
The following table describes Cisco EnergyWise attributes.
Attribute |
Definition |
Defaults |
---|---|---|
Importance |
Device rating based on the business or deployment context. |
The range is from 1 (least important) to 100 (most important). The default is 1. |
Keywords |
Device description (other than the name or role) for which query results are filtered. |
None. |
Name |
Device identity for which query results are filtered. |
For a PoE port, the short version of the port name. For example, Gi0.2 for Gigabit Ethernet 0/2. For a domain member, the hostname. For an endpoint, see the endpoint documentation. We recommend that you use the hostname. |
Role |
Device function based on the business or deployment context. |
For a PoE port, the default is interface. For a domain member, the default can be the model number or the supervisor model number. For an endpoint, see the endpoint documentation. |
A Cisco EnergyWise network has three levels of security to prevent unauthorized communication.
The network enforces security with shared secrets, also referred to as passwords.
A recurrence is an event that repeats on a regular schedule. You can use this feature to schedule jobs to run periodically or at certain times or date. For example, you can configure the domain member to power an endpoint or interface on and off based on the time or date.
A recurrence uses the domain member time.
When configuring recurrences, you specify the time in CRON format (24-hour format). Cron is the time-based job scheduler in Unix computer operating systems.
When a recurrence occurs, changes to the Cisco EnergyWise power level exist only in the running configuration and are not saved in the startup configuration. If the domain member fails and then restarts, it uses the power level in the saved startup configuration.
For time format, use the 24-hour clock. The time zone is based on the domain member.
Note |
When configuring recurrences, do not schedule multiple recurrence events to start at the same time. We recommend that you configure events at least 15 minutes apart. |
When you use the day_of_month and the day_of_week variables in the energywise level level recurrence importance importance at minute hour day_of_month month day_of_week interface configuration command, follow these guidelines:
The management station sending a query receives all the power-usage responses from the EnergyWise domain. The domain members use neighbor relationships to forward the query.
For secure communication, the domain members use a shared secret and send only authenticated queries to the endpoints.
Number |
Process |
---|---|
1 |
The management station sends queries and messages to the domain. |
2 |
The domain member replies to queries and messages from the management station. |
3 |
The domain member sends queries and messages to other domain members and endpoints. |
4 |
The domain member replies to queries and messages from other domain members and endpoints. |
EnergyWise supports the following query types:
You can use these attributes to filter the results:
The query results show domain members and endpoints with importance values less than or equal to the specified value in the query.
You can use this feature to ensure that the switch does not power off a phone that is in use. For example, if you have a Cisco IP phone connected to a PoE port and activity check is enabled, the switch does not power off the phone if it is sending or receiving voice traffic. If the phone is not in use, it powers off within approximately 1 minute. If a PC is connected to the switch port of the phone, the PC loses network connectivity when the phone is powered off.
You can configure activity check on these Cisco devices:
Note |
Before powering off a PoE port, Catalyst 6500 series switches and Catalyst 4500 series switches use interface statistics to determine whether a Cisco IP phone connected to the PoE port is not sending or receiving traffic. |
After you have enabled activity check, perform the following checks to make sure that the switch powers off the port only when a connected Cisco IP phone is not sending or receiving voice traffic.
Use the show mls qos interface statistics privileged EXEC command to display the port QoS statistics, including the number of packets in queue 1.
Wake on LAN (WoL) is an Ethernet computer networking standard that uses a network message called a magic packet to wake up an endpoint device. The magic packet contains the MAC address of the destination endpoint device (typically a PC). For example, you can send a WoL magic packet to a PC. The listening PC waits for a magic packet addressed to it and then initiates the system to wake up.
WoL is implemented on the motherboard (BIOS) and the network interface. It is operating-system independent. WoL could be disabled by default on some PCs.
You can configure the EnergyWise domain member to send a WoL magic packet to a specific endpoint device or all endpoint devices in the EnergyWise network. When a WoL-enabled PC is connected to the domain member, it receives the WoL magic packet and the power level of the PC changes from nonoperational to operational.
Some network interface cards (NICs) have a SecureOn feature with which you can store a hexadecimal password within the NIC. When you send WoL packets to NICs with SecureOn, the NICs store this password as part of the packet, making the wake up process secure. If the PC you are trying to wake up has an NIC that supports SecureOn, the domain member must send a magic packet with the hexadecimal password to power on the PC.
Simple Network Management Protocol (SNMP) is an application-layer protocol that provides a message format for communication between managers and agents. SNMP provides a standardized framework and a common language used for the monitoring and management of devices in a network.
You can monitor, control, and report the energy usage of endpoint devices that are connected to a Cisco network even if a Cisco EnergyWise agent is not installed on these devices. An EnergyWise domain member can use SNMP to communicate with these endpoint devices.
To use SNMP, you have to configure an EnergyWise SNMP proxy on the domain member that the endpoint device is connected to. When you send a query from the domain member (where EnergyWise SNMP proxy is configured) to the SNMP device, the query is translated to an SNMP request and the SNMP response is translated back to an EnergyWise response.
EnergyWise translates queries with the help of an XML file that is stored in the flash drive of the domain member. The number of XML files you need depends on the number and type of devices that you use. For example, if you have one or more printers using SNMP, you need to load one XML file for each printer type and model. You have to configure one EnergyWise SNMP proxy for each printer.
The following figure shows how a domain member running EnergyWise SNMP Proxy enables an SNMP-capable printer to join the EnergyWise domain.
To display all the devices for which you have configured an SNMP proxy, use the show energywise proxies privileged EXEC command.
For EnergyWise proxy-related debugging, use the debug energywise endpoint and debug energywise query privileged EXEC commands.
Note |
An EnergyWise query using this command cannot be translated to an SNMP request: energywise query importance importance {keywords word,word,... | name name} collect delta privileged EXEC command. You can use all other EnergyWise query commands. |
Configuration Guidelines
By default, Cisco EnergyWise is disabled on the domain member.
If you enter the no energywise level interface configuration command, the domain member does not immediately change to the default power level. The power level changes when you restart the domain member or enter the energywise level level command.
For a domain member with PoE ports, such as a PoE-capable switch:
If a port is error-disabled:
You can configure EnergyWise on the port and configure the port power level.
The following table shows you how to find out if a domain member port participates in Cisco EnergyWise. For each combination of port and PoE mode check the matrix entry, if it is Yes, then the port participates in Cisco EnergyWise; if it is No, then the port does not participate in EnergyWise.
For example, if the port is PoE and the PoE mode is never, the table matrix entry is No; this means Cisco EnergyWise is not disabled even if the port power is off.
Port |
PoE Mode—auto |
PoE Mode—never |
PoE mode—static |
---|---|---|---|
PoE |
Yes |
No |
Yes |
Non-PoE |
No |
No |
No |
When you change the port mode using the power inline auto or power inline static interface configuration commands, changes are effective immediately. You do not need to restart the domain member.
If Cisco EnergyWise is disabled, the domain member can use PoE to manage the port power usage.
When you configure a recurrence for PoE interfaces, EnergyWise functions the same way as when the power inline and no power inline interface configuration commands are executed. You might see messages that show the interface going up and down at time of the event.
Follow these guidelines for EnergyWise to work properly:
To display the Cisco EnergyWise version running on your domain member, use the show energywise version privileged EXEC command. The Cisco EnergyWise version is referred to as the EnergyWise specification in the command output.
To display the software version running on your domain member, use the show version privileged EXEC command.
In Cisco EnergyWise Version 1, these commands were modified:
How to Configure EnergyWise
1. configure terminal
2. service password-encryption
3. energywise domain domain-name security {ntp-shared-secret | shared-secret } [0 | 7] domain-password [protocol udp port udp-port-number [interface interface-id | ip ip-address] ]
5. show energywise
6. show energywise domain
1. configure terminal
2. energywise importance importance
3. energywise keywords word, word, word...
4. service password-encryption
5. energywise management security shared-secret [ 0 | 7] mgmt-password [port tcp-port-number]
6. energywise name name
7. energywise neighbor [ hostname | ip-address ] udp-port-number
8. energywise role role
9. energywise allow query [save | set]
10. energywise endpoint security [ none | shared-secret [ 0 | 7 ] shared-secret]
12. show energywise
13. show energywise domain
1. configure terminal
3. energywise level level
5. show energywise
6. show energywise domain
Before entering the energywise activitycheck command in Step 7:
1. configure terminal
3. energywise importance importance
4. energywise keywords word, word, word...
5. energywise name name
6. energywise role role
7. energywise activitycheck
8. energywise allow query set
10. show running-config
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 | configure terminal Example: DomainMember# configure terminal |
Enters the global configuration mode. |
||
Step 2 |
interface
interface-id Example: DomainMember(config)# interface gigabitethernet1/0/2 |
Specifies the port or the range of ports to be configured, and enters interface configuration mode. |
||
Step 3 | energywise importance importance Example: DomainMember (config-if)# energywise importance 90 |
Sets the importance. The range is from 1 to 100. The default is 1. |
||
Step 4 | energywise keywords word, word, word... Example: DomainMember (config-if)# energywise keywords lab |
Assigns at least one keyword. When assigning multiple keywords, separate the keywords with commas, and do not use spaces between keywords.
By default, keywords are not defined. |
||
Step 5 | energywise name name Example: DomainMember (config-if)# energywise name labphone.5 |
Specifies the EnergyWise-specific name.
The default is the host name. |
||
Step 6 | energywise role role Example: DomainMember (config-if)# energywise role role.labphone |
Specifies the role in the EnergyWise domain. For example, lobby.b20.
The default is the model number. |
||
Step 7 | energywise activitycheck Example: DomainMember (config-if)# energywise activitycheck |
Verifies that the connected IP phone is not sending or receiving traffic before the domain member powers off the port.
|
||
Step 8 | energywise allow query set Example: DomainMember (config-if)# energywise role role.labphone |
If the interface receives a query from the management station or another domain member, configures the interface to respond to a query changing the power level and the EnergyWise attributes. By default, the domain member responds to this query. |
||
Step 9 |
end Example: DomainMember (config-if)# end |
|||
Step 10 | show running-config Example: DomainMember# show running-config |
Verifies your entries. |
||
Step 11 |
copy running-config startup-config Example: DomainMember# copy running-config startup-config |
1. show energywise
2. configure terminal
3. time-range time-range-name
4. absolute start hh:mm day_of_month month year
5. periodic days_of_the_week hh:mm
7. energywise level level recurrence importance importance {at minute hour day_of_month month day_of_week | time-range time-range-name}
9. show energywise recurrence
Command or Action | Purpose | |
---|---|---|
Step 1 | show energywise Example: DomainMember# show energywise |
Verifies that EnergyWise is enabled. |
Step 2 | configure terminal Example: DomainMember# configure terminal |
Enters the global configuration mode. |
Step 3 | time-range time-range-name Example: DomainMember(config)# time-range onfirstfloor |
Assigns a name to the time range, and enters the time-range configuration mode. If you do not configure a time range, go to Step 6. The time range is based on the system clock.
Use the absolute and the periodic time-range configuration commands to specify times and days for a recurrence. You can use one absolute condition and multiple periodic conditions. |
Step 4 | absolute start hh:mm day_of_month month year Example: DomainMember(config-time-range)# absolute start 0:00 1 August 2009 |
Sets the start time and day for the recurrence. If the absolute condition has an end time and day, the domain member ignores these values. |
Step 5 | periodic days_of_the_week hh:mm Example: DomainMember(config-time-range)# periodic weekdays 06:00 to 22:00 DomainMember(config-time-range)# periodic weekend 10:00 to 16:00 |
Sets the weekly start time and day for the recurrence.
|
Step 6 |
interface
interface-id Example: DomainMember(config)# interface gigabitethernet1/0/2 |
Specifies the port or a range of ports to be configured, and enters interface configuration mode. |
Step 7 | energywise level level recurrence importance importance {at minute hour day_of_month month day_of_week | time-range time-range-name} Example: DomainMember(config-if)# energywise level 10 recurrence importance 70 time-range onfirstfloor |
Schedules a power-on or power-off event.
The event uses the domain member time. Repeat this step to schedule another event. |
Step 8 |
end Example: DomainMember(config)# end |
|
Step 9 | show energywise recurrence Example: DomainMember# show energywise recurrence |
Verifies your entries. |
Step 10 |
copy running-config startup-config Example: DomainMember# copy running-config startup-config |
Note |
If the timeout value in the energywise query importance privileged EXEC command is too short, the management station does not receive query results even if the domain members and endpoints respond to the query. For example, if you want to power off a specific phone but the timeout value in the energywise query importance command is too short, the phone is not powered off. When configuring the timeout, configure a minimum of 6 seconds to display correct output. |
In the procedure, Steps 2 and 3 are interchangeable. You can perform either Step 2 or Step 3.
1. energywise query analyze domain domain-name
2. energywise query importance importance {keywords word, word,... | name name} collect {delta | usage} [all [timeout timeout] | consumer [timeout timeout] | meter [timeout timeout] | producer [timeout timeout] | timeout timeout]
3. energywise query importance importance {keywords word, word,... | name name} sum {delta | usage} [all [timeout timeout] | consumer [timeout timeout] | meter [timeout timeout] | producer [timeout timeout] | timeout timeout]
4. energywise query importance importance {keywords word, word,... | name name} set level level [all [ timeout timeout ] | consumer [ timeout timeout ] | meter [ timeout timeout ] | producer [ timeout timeout ] timeout timeout ]
Command or Action | Purpose | |||||
---|---|---|---|---|---|---|
Step 1 | energywise query analyze domain domain-name Example: DomainMember# energywise query analyze domain |
Runs a query to analyze and display information about the domain, including the domain size and the number of members and endpoints. |
||||
Step 2 | energywise query importance importance {keywords word, word,... | name name} collect {delta | usage} [all [timeout timeout] | consumer [timeout timeout] | meter [timeout timeout] | producer [timeout timeout] | timeout timeout] Example: DomainMember# energywise query importance 100 name * collect usage consumer |
Runs a query to display power information for the domain members and endpoints. Runs a query to change the power level and to power on or off the domain members, PoE ports, or endpoints.
The default timeout is 6 seconds. The range is from 1 to 180. Repeat this step to run another query. |
||||
Step 3 | energywise query importance importance {keywords word, word,... | name name} sum {delta | usage} [all [timeout timeout] | consumer [timeout timeout] | meter [timeout timeout] | producer [timeout timeout] | timeout timeout] Example: DomainMember# energywise query importance 90 keyword lobby sum usage |
You can perform Step 2 or Step 3 |
||||
Step 4 | energywise query importance importance {keywords word, word,... | name name} set level level [all [ timeout timeout ] | consumer [ timeout timeout ] | meter [ timeout timeout ] | producer [ timeout timeout ] timeout timeout ] Example: DomainMember# energywise query importance 80 name shipping.2 set level 0 |
(Optional) Runs a query to change the power level and to power on or off the domain members, PoE ports, or endpoints.
The default is 6 seconds. The range is from 1 to 180. Repeat this step to run another query. |
To activate the hibernation immediately, run the following EnergyWise query in the privileged EXEC mode:
Check that you have configured a hibernation end time.
1. energywise query importance importance name name set level level
Command or Action | Purpose | |
---|---|---|
Step 1 | energywise query importance importance name name set level level Example: DomainMember# energywise query importance 90 name cisco building1 set level 1 |
Immediately hibernates all the switches in the domain matching the given name. Hibernation ends at the time that you have specified by using the energywise level global configuration command. |
The switch console displays the scheduled hibernation end times before hibernating. For example:
=========================================== Power level: Hibernation Hibernation start time:--- -- ---- --:--:-- Hibernation end time: May 02 2013 03:00:00 To end hibernation ahead of schedule, push the Mode button. ===========================================
Follow this procedure to configure a Cisco IOS time-based recurrence with scheduled hibernation start and end times.
1. show energywise
2. configure terminal
3. time-range time-range-name
4. absolute start hh:mm day_of_month month year
5. periodic days_of_the_week hh:mm to hh:mm
6. exit
7. energywise level level recurrence importance importance time-range time-range-name
8. exit
9. show energywise recurrence
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 | show energywise Example: DomainMember# show energywise |
Verifies that EnergyWise is enabled. |
||
Step 2 | configure terminal Example: DomainMember# configure terminal |
Enters the global configuration mode. |
||
Step 3 | time-range time-range-name Example: DomainMember(config)# time-range building1 |
Assigns a name to the time range and enters the time-range configuration mode. The time range is based on the system clock. If EnergyWise is not running on the switch (for example, a PoE switch), the specified times are based on the domain member time zone. After entering the time-range time-range-name command, configure the periodic time-range configuration command, the absolute time-range configuration command, or a combination of the commands to define when the feature is in effect. Multiple periodic commands are allowed in a time range; only one absolute command is allowed. |
||
Step 4 | absolute start hh:mm day_of_month month year Example: DomainMember(config-time-range)# absolute start 0:00 1 August 2013 |
For more information, see the absolute time-range configuration command in the Cisco IOS Configuration Fundamentals Command Reference. |
||
Step 5 | periodic days_of_the_week hh:mm to hh:mm Example: DomainMember(config-time-range)# periodic weekdays 00:00 to 05:30 DomainMember(config-time-range)# periodic weekdays 21:00 to 23:59 |
Sets the weekly start time and day for the recurrence. You can specify these values:
You can enter multiple periodic conditions. For each periodic condition you must enter the start and end time. The absolute starthh:mm day_of_month month year time-range configuration command, if configured, takes precedence over the periodic start. If an absolute condition is not configured, the periodic start applies. For more information, see the periodic time-range configuration command in the Cisco IOS Configuration Fundamentals Command Reference. |
||
Step 6 | exit Example: DomainMember(config-time-range)# exit |
Exits the time-range configuration mode and returns to the global configuration mode. |
||
Step 7 | energywise level level recurrence importance importance time-range time-range-name Example: DomainMember(config)# energywise level 1 recurrence importance 100 time-range building1 |
Sets the power level and schedules a recurrence.
Recurrences use the domain member time. To see domain member time, enter the show clock privileged EXEC command. If you configure multiple recurrences using this comment, the system uses the one that is configured first. Only after the first recurrence is removed does the next recurrence with the energywise level 1 configuration take effect. |
||
Step 8 | exit Example: DomainMember(config)# exit |
Exits the global configuration mode. |
||
Step 9 | show energywise recurrence Example: DomainMember# show energywise recurrences |
Displays the EnergyWise settings and status for recurrence. |
Building configuration... [OK] Apr 20 20:51:59.235: %SYS-5-CONFIG_I: Configured from console by console =========================================== Power level: Hibernation Hibernation start time: Apr 20 2013 20:52:00 Hibernation end time: Apr 20 2013 20:58:00 To end hibernation ahead of schedule, push the Mode button. ===========================================
1. configure terminal
2. interface interface-id
3. energywise activity check
Command or Action | Purpose | |||
---|---|---|---|---|
Step 1 | configure terminal Example: DomainMember# configure terminal |
Enters the global configuration mode. |
||
Step 2 | interface interface-id Example: DomainMember(config)# interface gigabitethernet0/2 |
Specifies the port or a range of ports to be configured, and enters the interface configuration mode. In the examples, the interface-id is in this format: type slot-or-module-number/port-number, for example, gigabitethernet 0/5. To specify an interface, see your device software documentation. |
||
Step 3 | energywise activity check Example: DomainMember(config-if)# energywise activitycheck |
Configures the domain member to wait until a Cisco IP phone connected to a PoE port is not sending or receiving traffic before the domain member powers off the port.
|
Proceed to test activity check.
Save the XML file on the TFTP server. This action enables you to load the XML file in this procedure.
1. copy tftp://IP address/XML file
2. configure terminal
3. snmp-server manager
4. energywise proxy mapping map_name word
6. energywise proxy mapping map_name protocol protocol host host discovery-interval interval port port
7. energywise proxy protocol protocol version version community-string community-string
Command or Action | Purpose | |
---|---|---|
Step 1 | copy tftp://IP address/XML file Example: copy tftp://2.2.2.201/xyz/example1.xml |
Uses TFTP to load the XML files on to the domain member. |
Step 2 | configure terminal Example: DomainMember# configure terminal |
Enters the global configuration mode. |
Step 3 | snmp-server manager Example: DomainMember(config)# snmp-server manager |
Enables the SNMP server manager and allows the domain member to act as an SNMP manager. By acting as an SNMP manager, the domain member can send SNMP requests to agents and receive SNMP responses and notifications from agents. By default, the SNMP manager is disabled. |
Step 4 | energywise proxy mapping map_name word Example: DomainMember(config)# energywise proxy mapping aliasmapname1 flash:/example1.xml |
Sets an alias for the XML file. |
Step 5 |
interface
interface-id Example: DomainMember(config)# interface gigabitethernet1/0/2 |
Specifies the port or the range of ports to be configured, and enters interface configuration mode. |
Step 6 | energywise proxy mapping map_name protocol protocol host host discovery-interval interval port port Example: DomainMember(config-if)# energywise proxy mapping aliasmapname1 protocol snmp host 2.2.2.11 port 161 |
Sets up the XML file and configures credentials.
|
Step 7 | energywise proxy protocol protocol version version community-string community-string Example: DomainMember(config-if)# energywise proxy snmp version v2c community-string private |
Configures an SNMP proxy on one or more interfaces.
|
1. energywise query importance importance {keywords word, word,... | name name} wol mac mac-address [password password | port tcp-port-number [password password]]
Command or Action | Purpose | |||||
---|---|---|---|---|---|---|
Step 1 | energywise query importance importance {keywords word, word,... | name name} wol mac mac-address [password password | port tcp-port-number [password password]] Example: DomainMember# energywise query importance 100 keyword PC wol mac 0123.4567.89ab |
Sends a WoL magic packet to a specific device or to all devices in the EnergyWise network.
|
To use WoL without entering a MAC address, first configure the EnergyWise endpoint device to include off-state caching and WoL. To wake up the device and set its power level, use the energywise query privileged EXEC command. For example, enter this command:
DomainMember# energywise query importance 100 keywords pc set level 10
Device MAC addresses are cached along with their keywords or names. The domain member matches the keywords or name you enter with the cached keywords, names, and MAC addresses and sends the WoL packet to the matching device.
The WoL packet is sent only if the device is powered off.
Monitoring and Troubleshooting EnergyWise
Use the following commands to monitor EnergyWise.
Command |
Purpose |
---|---|
show energywise |
Displays the settings and status for the domain member or endpoint. |
show energywise children |
Displays the status of the connected endpoints. |
show energywise provisioned |
Displays a summary of the EnergyWise information for the domain member and the connected endpoints. |
show energywise domain |
Displays the domain to which the domain member or endpoint belongs. |
show energywise events |
Display the last ten events (messages) sent to other domain members or endpoints in the domain. |
show energywise neighbor |
Displays the neighbor tables for the domain member. |
show energywise recurrences |
Displays the EnergyWise settings and status for recurrence. |
show energywise statistics |
Displays the counters for events and errors. |
show energywise usage |
Displays the actual power usage on the domain member or endpoint. |
show energywise version |
Displays the EnergyWise version. |
show version |
Displays the software version. |
show power inline |
Displays the PoE status. |
show cdp neighbors |
Displays the neighbors discovered by CDP. |
This example shows you how to verify that the Cisco 7960 IP Phone uses 6.3 W and that the Cisco 7970G IP Phone uses 10.3 W:
Switch# show energywise usage children Interface Name Usage Caliber --------- ---- ----- ------- Switch 144.0 (W) max Gi0/1 Gi0.1 6.3 (W) trusted Gi0/2 Gi0.2 10.3 (W) trusted
Use the EnergyWise debug mode commands to show communication failures.
Command |
Purpose |
---|---|
debug energywise debug |
Displays errors such as invalid sequence numbers and communication errors on the domain. |
debug energywise discovery |
Displays all EnergyWise discovery information. |
debug energywise endpoint |
Displays information about EnergyWise endpoints running a client or agent and helps detect mismatched domain names, secrets, and sequence numbers of connected endpoints. |
debug energywise ha |
Displays EnergyWise high availability (HA) information for devices that have HA capability. |
debug energywise management |
Displays information about authentication failures and EnergyWise management stations running power management applications. |
debug energywise packet |
Displays EnergyWise packet trace information. |
debug energywise query |
Displays query information relating to the device from which the query is initiated. |
debug energywise trace |
Displays information about all the EnergyWise processes relating to the device from which the query is initiated. |
debug energywise wol |
Displays Wake on LAN (WoL) query information relating to the device from which the query is initiated. |
To disable EnergyWise, enter the interface configuration commands followed by the global configuration commands.
Command |
Purpose |
---|---|
no energywise |
Disables EnergyWise on the PoE port or on the endpoint. |
no energywise activitycheck |
Configures the domain member not to wait until a Cisco IP phone connected to a PoE port is not sending or receiving voice traffic before the domain member powers off the port. |
no energywise allow query set |
Configures the interface to drop all set queries for the interface and children. If configured, you cannot change the power level or EnergyWise attributes of connected devices on the interface. To prevent power levels on all interfaces from being changed, apply the command to all interfaces. |
no energywise [ importance | keywords [ word, word, ....]| level | name [name] | role [role]] |
Removes the EnergyWise configuration on a domain member port. If you enter the no energywise level command, the domain member changes the power level to the default only when you restart the domain member or you enter the energywise level level command. |
no energywise level level recurrence importance importance {at minute hour day_of_month month day_of_week | timerange timerange-name} |
Removes the recurrence configuration on a domain member port. |
Command |
Purpose |
---|---|
no energywise allow query save |
Configures the domain member not to respond to a query that saves the running configuration. |
no energywise allow query set |
Configures the domain member to drop all set queries for the parent entity. If configured, you cannot change the power level or EnergyWise attributes of the domain member. This configuration does not apply to the interfaces or endpoints connected to any interfaces. |
no energywise domain |
Disables EnergyWise on the domain member. |
no energywise endpoint |
Configures the domain member not to establish parent-child relationships with connected EnergyWise-compatible endpoints. The endpoints cannot receive queries or messages from the domain member. |
no energywise{importance | keywords [word ,word,...] | name | neighbor [hostname | ip-address] udp-port-number | role} |
Removes the EnergyWise configuration on the domain member. |
no energywise management |
Configures the domain member to not communicate with a connected management station that sends queries. |
Configuration Examples for EnergyWise
The following example displays how to set the domain:
DomainMember# show energywise Interface Role Name Usage Lvl Imp Type --------- ---- ---- ----- --- --- ---- fanfare jsmith 1009.0(W) 5 100 paren DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# energywise domain cisco security ntp-shared-secret cisco protocol udp port 43440 ip 2.2.4.30 DomainMember(config)# energywise importance 50 DomainMember(config)# energywise keywords lab1,devlab DomainMember(config)# energywise name LabSwitch DomainMember(config)# energywise neighbor member1 43440 DomainMember(config)# energywise role role.labaccess DomainMember(config)# energywise allow query save DomainMember(config)# end DomainMember# show energywise domain Name : member1 Domain : cisco Protocol : udp IP : 2.2.2.21 Port : 43440 DomainMember# show energywise neighbors Capability Codes: R - Router, T - Trans Bridge, B - Source Route Bridge S - Switch, H - Host, I - IGMP, r - Repeater, P - Phone Id Neighbor Name Ip:Port Prot Capability -- ------------- ------- ---- ---------- 1 member-21 2.2.2.21:43440 udp S I 2 member-31 2.2.4.31:43440 static S I 3 member-22 2.2.2.22:43440 cdp S I
The following example displays how to manually manage the power.
To power on the lab IP phones:
DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port 43440 ip 2.2.4.44 DomainMember(config)# interface gigabitethernet0/3 DomainMember(config-if)# energywise importance 65 DomainMember(config-if)# energywise name labphone.5 DomainMember(config-if)# energywise role role.labphone DomainMember(config-if)# end
To power off an IP phone connected to a PoE port:
DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port 43440 ip 2.2.4.44 DomainMember(config)# interface gigabitethernet0/2 DomainMember(config-if)# energywise importance 65 DomainMember(config-if)# energywise name labphone.5 DomainMember(config-if)# energywise role role.labphone DomainMember(config-if)# energywise level 0 DomainMember(config-if)# end
The domain member powers the IP phone whether Cisco EnergyWise is enabled or not.
The following example displays how to automatically manage the power:
DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port 43440 ip 2.2.4.30 DomainMember(config)# interface gigabitethernet1/0/3 DomainMember(config-if)# energywise level 10 recurrence importance 90 at 0 8 * * * DomainMember(config-if)# energywise level 0 recurrence importance 90 at 0 20 * * * DomainMember(config-if)# energywise importance 50 DomainMember(config-if)# energywise name labInterface.3 DomainMember(config-if)# energywise role role.labphone DomainMember(config-if)# end DomainMember# show energywise recurrences Id Addr Class Action Lvl Cron -- ---- ----- ------ --- ---- 1 Gi0/3 QUERY SET 10 minutes: 0 hour: 8 day: * month: * weekday: * 2 Gi0/3 QUERY SET 0 minutes: 0 hour: 20 day: * month: * weekday: * DomainMember# show running-config <output truncated> interface GigabitEthernet0/3 energywise level 10 recurrence at 0 8 * * * energywise level 0 recurrence at 0 20 * energywise importance 50 energywise role role.labphone energywise name labInterface.3 end <output truncated>
To automatically power on the lab IP phones at 08:00 and power off at 20:00:
DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port 43440 ip 2.2.4.30 DomainMember(config)# interface gigabitethernet1/0/3 DomainMember(config-if)# energywise level 10 recurrence importance 90 at 0 8 * * * DomainMember(config-if)# energywise level 0 recurrence importance 90 at 0 20 * * * DomainMember(config-if)# energywise importance 50 DomainMember(config-if)# energywise name labInterface.3 DomainMember(config-if)# energywise role role.labphone DomainMember(config-if)# end DomainMember# show energywise recurrences Id Addr Class Action Lvl Cron -- ---- ----- ------ --- ---- 1 Gi0/3 QUERY SET 10 minutes: 0 hour: 8 day: * month: * weekday: * 2 Gi0/3 QUERY SET 0 minutes: 0 hour: 20 day: * month: * weekday: * DomainMember# show running-config <output truncated> interface GigabitEthernet0/3 energywise level 10 recurrence at 0 8 * * * energywise level 0 recurrence at 0 20 * energywise importance 50 energywise role role.labphone energywise name labInterface.3 end <output truncated>
To automatically power on the PCs on the first floor at 06:00 and power off at 21:00:
DomainMember# configure terminal Enter configuration commands, one per line. End with CNTL/Z. DomainMember(config)# service password-encryption DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port 43440 ip 2.2.4.30 DomainMember(config)# time-range onfirstfloor DomainMember(config-time-range)# absolute start 0:00 1 August 2009 DomainMember(config-time-range)# periodic daily 06:00 to 21:00 DomainMember(config)# time-range offfirstfloor DomainMember(config-time-range)# absolute start 0:00 1 August 2009 DomainMember(config-time-range)# periodic daily 00:00 to 05:55 DomainMember(config-time-range)# periodic daily 21:01 to 23:59 DomainMember(config-time-range)# exit DomainMember(config)# interface gigabitethernet0/3 DomainMember(config-if)# energywise level 10 recurrence importance 70 time-range onfirstfloor DomainMember(config-if)# energywise level 0 recurrence importance 70 time offfirstfloor DomainMember(config-if)# energywise name floor.1 DomainMember(config-if)# energywise role pc-mgr DomainMember(config-if)# end DomainMember# show energywise recurrences Id Addr Class Action Lvl Cron -- ---- ----- ------ --- ---- 1 Gi0/3 QUERY SET 10 onfirstfloor 2 Gi0/3 QUERY SET 0 offfirstfloor DomainMember# show running-config <output truncated> interface GigabitEthernet0/3 energywise level 10 recurrence importance 70 time-range onfirstfloor energywise level 0 recurrence importance 70 time-range offfirstfloor energywise role pc-mgr energywise name floor.1 end <output truncated>
Note |
Cisco EnergyWise uses only the start time for the absolute condition. Any configured end times are ignored. However, a start and end time is mandatory for the periodic condition. |
This example shows how to display information about the domain, such as the number of members, endpoints and the domain size:
DomainMember# energywise query analyze domain EnergyWise is currently analyzing the domain, please wait... EnergyWise Domain Statistics ---------------------------- Querying from HW Model: WS-C3560G-48PS Number of Domain Members: 3 Number of Endpoints: 1
In this example, Switch 1 and Switch 2 are in the same domain. shipping.1 is a PoE port on Switch 1, and shipping.2 is a PoE port on Switch 2.
The example shows the power usage of the domain members and endpoints with names beginning with shipping and with importance values less than or equal to 80. Run this query on Switch 1:
DomainMember# energywise query importance 80 name shipping.* collect usage EnergyWise query, timeout is 6 seconds: Host Name Usage Level Imp ---- ---- ----- ----- --- 192.168.20.1 shipping.1 6.3 (W) 10 1 192.168.20.2 shipping.2 8.5 (W) 10 1 Queried: 2 Responded: 2 Time: 0.4 seconds
The first row (shipping.1) is from Switch 1. The second row (shipping.2) is from Switch 2, a neighbor of Switch 1.
In this example, Switch 1 and Switch 2 are in the same domain. shipping.1 is a PoE port on Switch 1, and shipping.2 is a PoE port on Switch 2.
The example shows the power usage of IP phones with different names, different roles, and importance values less than or equal to 80, but all that have the Admin keyword. Run this query on Switch 1:
DomainMember# energywise query importance 80 keyword Admin collect usage EnergyWise query, timeout is 6 seconds: Host Name Usage Level Imp ---- ---- ----- ----- --- 192.168.40.2 shipping.1 6.3 (W) 10 1 192.168.50.2 orders.1 10.3 (W) 10 1 192.168.60.3 pc.1 200.0 (W) 8 75 Queried: 3 Responded: 3 Time: 0.5 seconds
Switch 1 reports two phones connected to Switch 2, a neighbor of Switch 1.
Note |
Do not run a query with keywords *. No results are generated. |
In these examples shipping.1 and shipping.2 are PoE ports on Switch 1. Run these queries on Switch 1:
DomainMember# energywise query importance 80 name shipping.2 set level 0
DomainMember# energywise query importance 90 name shipping.* set level 0
DomainMember# energywise query importance 60 keyword Admin set level 10 EnergyWise query, timeout is 6 seconds: !!!! Success rate is (2/2) setting entities Queried: 2 Responded: 2 Time: 0.15 seconds
To show the power usage of EnergyWise devices with usage type all:
DomainMember# energywise query importance 100 name * collect usage all EnergyWise query, timeout is 6 seconds: Host Name Usage Level Imp ---- ---- ----- ----- --- 10.1.2.83 SEP5475d0db0dcb 3.8 (W) 10 5 10.1.2.71 SEP1C17D340834E 8.8 (W) 10 1 10.1.2.68 SEP3037A61748E2 8.8 (W) 10 1 10.1.2.211 Local_InfeedA_Outlet1 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet2 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet3 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet4 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet5 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet6 34.0 (W) 0 50
To show the power usage of an IP phone with usage type consumer:
DomainMember# energywise query importance 100 name * collect usage consumer EnergyWise query, timeout is 6 seconds: Host Name Usage Level Imp ---- ---- ----- ----- --- 10.1.2.83 SEP5475d0db0dcb 3.8 (W) 10 5 10.1.2.71 SEP1C17D340834E 8.8 (W) 10 1 10.1.2.68 SEP3037A61748E2 8.8 (W) 10 1
To show the power usage of a PDU outlet with usage type meter:
DomainMember# energywise query importance 100 name * collect usage meter EnergyWise query, timeout is 6 seconds: Host Name Usage Level Imp ---- ---- ----- ----- --- 10.1.2.211 Local_InfeedA_Outlet1 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet2 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet3 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet4 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet5 0.0 (W) 0 50 10.1.2.211 Local_InfeedA_Outlet6 34.0 (W) 0 50
This example shows you how to configure a Cisco IOS time-based recurrence. Time-range building1hibernate is created and the periodic condition is used to configure the hibernation start and end times from 01:00 a.m. to 09:00 a.m. on weekdays.
DomainMember(config)# energywise domain cisco security shared-secret cisco protocol udp port43440 ip 2.2.4.30
DomainMember(config)# time-range building1hibernate DomainMember(config-time-range)# periodic weekdays 01:00 to 09:00 DomainMember(config-time-range)# exit
DomainMember(config)# energywise level 1 recurrence importance 100 time-range building1hibernate
In this example, CoS value 5 is mapped to queue 1 and threshold 3 on the Gigabit Ethernet 0/1 port:
Cos-outputq-threshold map: cos: 0 1 2 3 4 5 6 7 ------------------------------------------------------------- queue-threshold: 4-3 4-2 3-3 2-3 3-3 1-3 2-3 2-3
<output truncated> interface GigabitEthernet0/1 srr-queue bandwidth share 10 10 60 20 queue-set 2 priority-queue out mls qos trust device cisco-phone mls qos trust cos auto qos voip cisco-phone service-policy input AutoQoS-Police-CiscoPhone <output truncated>
This example shows you how to test activity check. The example uses the show mls qos maps cos-output-q privileged EXEC command to show which output queue and threshold is mapped to CoS 5 for voice traffic. The show mls qos interface statistics privileged EXEC command then displays the number of packets in the output queue to determine if the domain member (an IP phone in this case) is sending out packets.
DomainMember# show mls qos maps cos-output-q Cos-outputq-threshold map: cos: 0 1 2 3 4 5 6 7 ---------------------------------------------------- queue-threshold: 2-1 2-1 3-1 3-1 4-1 1-1 4-1 4-1 <output truncated>
CoS 5 is mapped to queue-threshold: 1-1 (queue 1 and threshold 1):
DomainMember# show mls qos interface statistics output queues enqueued: queue: threshold1 threshold2 threshold3 ----------------------------------------------- queue 0: 0 0 0 queue 1: 0 0 0 queue 2: 0 0 0 queue 3: 0 0 0 <output truncated>
The output queue for queue 1 and threshold 1 is 0, which means that the phone is not sending out packets and the switch can power off the phone. If a phone conversation was in progress, the output queue would have nonzero packets in the output queue.
This example shows how to configure an SNMP endpoint proxy:
DomainMember# copy tftp://2.2.2.201/xyz/example1.xml DomainMember# configure terminal DomainMember# snmp-server manager DomainMember(config)# energywise proxy mapping Xerox1 flash:/example1.xml DomainMember(config)# interface gigabitethernet0/3 DomainMember(config-if)# energywise proxy mapping Xerox1 protocol snmp host 2.2.2.11 port 161 DomainMember(config-if)# energywise proxy snmp v2c community-string private
Related Topic | Document Title |
---|---|
List of Cisco network devices supporting Cisco EnergyWise |
Cisco IOS Release Notes for Cisco EnergyWise, EnergyWise Version 2.8 |
EnergyWise Commands |
Cisco EnergyWise IOS Command Reference Guide for Catalyst 2960-X Switches, EnergyWise Version 2.8 |
Cisco Integrated Service Routers Generation 2 (ISR G2) |
|
IP-Enabled Energy Management |
IP-Enabled Energy Management: A Proven Strategy for Administering Energy as a Service |
Cisco EnergyWise partner documentation |
|
MIB | MIBs Link |
---|---|
Cisco EnergyWise domain members support the CISCO-ENERGYWISE-MIB. | To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco IOS MIB Locator found at the following URL: |
Description | Link |
---|---|
The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies. To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds. Access to most tools on the Cisco Support website requires a Cisco.com user ID and password. |
Feature | Cisco IOS Release | Description |
---|---|---|
EnergyWise Version 2.8 | Cisco IOS Release 15.0(2)EX | This feature was introduced. |
Hibernation | Cisco IOS Release 15.0(2)EX3 | This feature was introduced. |