Cisco EnergyWise Configuration Guide, EnergyWise Phase 2
Managing Single Entities
Downloads: This chapterpdf (PDF - 517.0KB) The complete bookPDF (PDF - 2.52MB) | Feedback

Managing Single Entities

Table Of Contents

Managing Single Entities

Overview

Creating an EnergyWise Domain

Power Levels

Attributes

Recurring Event

Secure Domain Communication

MIBs

Switch Connected to an IP Phone

Switch Connected to a PC

Configuration Guidelines

Using the Call In-Progress Feature

PoE and EnergyWise Interactions

Preventing Network Access to a Non-Cisco End Point

CLI Compatibility Issues

Manually Managing Power

Enabling EnergyWise

Configuring Entity Attributes

Powering the PoE Port

Configuring Port Attributes

Configuring Recurring Events

Disabling EnergyWise

Examples

Setting the Domain

Manually Managing Power

Automatically Managing Power


Managing Single Entities


Overview

Creating an EnergyWise Domain

Power Levels

Attributes

Recurring Event

MIBs

Switch Connected to an IP Phone

Switch Connected to a PC

Configuration Guidelines

Using the Call In-Progress Feature

PoE and EnergyWise Interactions

Preventing Network Access to a Non-Cisco End Point

CLI Compatibility Issues

Manually Managing Power

Configuring Recurring Events

Disabling EnergyWise

Examples


Note If your switch is stacking-capable (for example, a Catalyst 3750-X, 3750-E, or 3750 switch), unless otherwise noted, the term switch refers to a standalone switch and to a switch stack.


For a list of Cisco network devices supporting Cisco EnergyWise, see the Cisco IOS Release Notes for Cisco EnergyWise, EnergyWise Phase 2 on Cisco.com.

For Cisco Integrated Service Routers Generation 2 (ISR G2), see the Configuring Cisco EnergyWise Feature for Branch Routers:
http://www.cisco.com/en/US/docs/routers/access/1900/software/configuration/guide/enrgyz_artg.html

See Cisco EnergyWise information:
http://www.cisco.com/en/US/products/ps10195/tsd_products_support_series_home.html.

See EnergyWise partner information on the Cisco Developer Network:
http://developer.cisco.com/web/esdk/home.

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.


For information about this warning, see the "Important Notice" appendix.

Overview

In a Cisco EnergyWise network, EnergyWise monitors and manages the power usage of powered devices: Cisco devices in a domain and all the connected end points.

An end point can be a device connected to the network, such as an IP phone, access point, or PC.

An entity refers to a domain member or an end point.

You can configure policies, referred to as recurring events or recurrences, to use time-of-day settings to automatically manage power usage.

Figure 1-1 EnergyWise Network

1

Network management stations

7

TCP

2

Domain members

8

UDP

3

End points

9

Runs queries and sets EnergyWise attributes

4

Management station

10

Runs, forwards, and responds to queries

5

Domain member

11

Responds to queries

6

End point

   

Management stations—Control applications and devices that use EnergyWise to monitor and manage the power usage of domain members and end points. Management stations also send queries.

Use the management application programming interface (API) to write a power management application.

Domain members—Cisco switches, routers, and network devices that use power. They forward messages across an EnergyWise domain consisting of other Cisco devices and end points. They also forward and reply to queries from the management station and other domain members and aggregate power-usage information from the end points.

A domain is treated as one unit of power management and is similar to a network-management community.

End points—Devices that use power. They only respond to queries.

Use the end-point software development kit (SDK) to implement an agent or client that participates as an EnergyWise end point.

Domain members and end points can receive power from an AC power source, a DC power source, or a power supply.

Power over Ethernet (PoE) domain members and end points can 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.

Creating an EnergyWise Domain

An EnergyWise domain is treated as one unit of power management and is similar to a network-management community (for example, a VLAN Trunking Protocol [VTP] domain). An EnergyWise domain consists of Cisco domain members and end points. The domain members forward messages to other members and to end points.

For example, if you have a building with a core router, 10 access switches, and 400 end points, such as phones, access points, and PCs running the end point SDK, you can create an EnergyWise domain called MyBuilding with the router and switches as domain members.


Note If you want to implement power management applications on a management station and EnergyWise agents on the end points, the domain members must all run EnergyWise Phase 2 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.

Domain members use CDP when it is enabled or EnergyWise UDP messages to automatically discover neighbors.

You can manually configure static neighbors,

Each domain member sets up a parent-child relationship with an attached end point. The child is one of the 400 end points, and the parent is the domain member. For example, an IP phone (child) is connected to a PoE switch (parent), or a PC is connected to a router.

The EnergyWise domain can also have end points running custom SDK agents.

After the domain is set, a domain member can forward queries and control messages to other domain members and endpoints.

You can

Use SNMP or a management station to query every entity (domain member or end point).

Run an EnergyWise query to receive or set power usage information.

Use a management application, server, or CLI of a domain member to define power usage policies or receive power usage information.

Power Levels

The devices in an EnergyWise network are from different manufacturers. To manage power usage consistently, EnergyWise uses a set of power levels.

If a domain member sends an end point a request to change the power level, the end point determines the appropriate action.

Table 1-1 Power Levels 

Category
Level
Description

Operational

10

Full

9

High

8

Reduced

Standby

7

Medium

6

Frugal

5

Low

4

Ready

3

Standby

Nonoperational

2

Sleep

1

Hibernate

0

Shut off


The range is from 0 to 10.

The default is 10.

A Cisco switch does not support level 0. You cannot turn off the power on a switch.

A PoE end point, such as IP phone, receives power from a PoE switch port.

The power level is for the port.

The port supports levels 0 to 10.

If the port power level is 0, the port is powered off.

If the power level is from 1 to 10, the port is on.

Attributes

Table 1-2 Keywords, Name, and Role

 
Definition
Defaults

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 switch, the hostname.

For an end point, see the documentation for the end point and the agent or client running on it. 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 switch, the default can be the model number or the supervisor model number.

For an end point, see the documentation for the end point and the agent or client running on it.


Recurring Event

You can configure the switch to power an end point or interface on and off based on the time or date.

A recurring event, also referred to as a recurrence, uses the switch time.

The settings are only in the running configuration.

If the switch fails and then restarts, it uses the power level in the saved configuration.

Secure Domain Communication

Configure the security mode and password, referred to as the shared secret, to prevent replay attacks. You set either a strong password with Network Time Protocol (NTP) or a strong password without NTP.

When you use NTP to synchronize the time among domain members and you set a shared secret with NTP, EnergyWise uses the current time with the shared secret to enhance prevention of replay attacks.

MIBs

EnergyWise switches support the CISCO-ENERGYWISE-MIB.

For information, see the Release Notes for Cisco EnergyWise, EnergyWise Phase 2 on Cisco.com and go to http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml and click SNMP v2 MIBs or SNMP v3 MIBs.

You can also use FTP to access the MIB files.


Step 1 Make sure that your FTP client is in passive mode.


Note Some FTP clients do not support passive mode.


Step 2 Use FTP to access the server ftp.cisco.com.

Step 3 Log in with the username anonymous.

Step 4 Enter your e-mail username when prompted for the password.

Step 5 At the ftp> prompt, change directory to /pub/mibs/v2 or to /pub/mibs/v3.

Step 6 Use the get MIB_filename command to obtain a copy of the file.


Switch Connected to an IP Phone

Figure 1-2 Switch and IP Phone Scenario

1

Management station

3

End point

2

Domain member

   

The switch sends the end point a recurring event to power on at 0700 and to power off at 1900.

Switch Connected to a PC

Figure 1-3 Switch and PC Scenario

1

Management station

3

End point

2

Domain member

   

The switch sends the end point a recurring event to power on at 0600 and to power off at 2200.

Configuration Guidelines

By default, EnergyWise is disabled on the switch.

If you enter the no energywise level command, the switch does not immediately change the power level to the default. The power level changes when the switch restarts or when you enter the energywise level level command.

For a switch with PoE ports, such as a PoE-capable switch:

When you add the switch to a domain, EnergyWise is enabled on the switch and all the PoE switch ports.

Use the energywise level 0 interface configuration command to power off a PoE port.

You cannot use the energywise level 0 global configuration command to power off the switch.

If a port is in the error-disabled state:

It appears as an EnergyWise entity in the show command output and in the collect query results. The query results show that the port uses 0 W.

It does not respond to a set query.

When you use the energywise level level global configuration command to set the power level for a parent entity, you can only configure power level 10. Configuring any other power level has no effect on the parent entity.

For recurring events:

Specify time in the 24-hour format. For example, to set 0634

As a specific time, enter the energywise level level recurrence importance importance at 34 6 * * * interface configuration command.

In a time range, enter the absolute start 06:34 * * 2009 and the periodic daily 06:34 time-range configuration commands.

The time zone is based on the end point.

If EnergyWise is not running on the end point (for example, a PoE end point), the specified time is based on the switch time zone.

If an agent or client is running on the end point, the specified time is based on the end-point time zone.

If you configure the switch to power on an end point or a PoE port at a specific time, it powers on within 1 minute, for example, between 0700 and 0701.

If you configure the same recurring event for multiple end points, they all power on within 1 minute.


Note See the Release Notes for Cisco EnergyWise, EnergyWise Phase 2 on Cisco.com for software releases with Cisco EnergyWise Phase 2.


When you use the day_of_month and the day_of_week in the energywise level level recurrence importance importance at minute hour day_of_month month day_of_week interface configuration command in an EnergyWise Phase 2 software release:

The recurring event occurs when either the day_of_month or the day_of_week occurs first in releases earlier than the EnergyWise Phase 2 releases.

If you specify both the day_of_month and the day_of_week, the event occurs when either the day_of_month or the day_of_week is first.

If you specify the day_of_month and use a wildcard (*) for the day_of_week, the event occurs on the day_of_month.

If you use a wildcard for the day_of_month and specify the day_of_week, the event occurs on the day_of_week.

If you use wildcards for both the day_of_month and the day_of_week, the event occurs on any day.

After you upgrade the software to an EnergyWise Phase 2 release or later, a configured recurring event might occur less frequently than before the upgrade. Reconfigure the event.

If you use the energywise level level recurrence importance importance at minute hour 29 2 * interface configuration command to configure an event on February 29 in an EnergyWise Phase 2 software release:

Before you upgrade the software to an EnergyWise Phase 2 release or later, the event occurs every day in February.

After you upgrade the software, the event might not occur.

When configuring domains:

Use a strong password for the domain shared secret.

You must configure the same security mode, either an Network Time Protocol (NTP) or a non-NTP shared secret, for all the domain members.

You must use a strong password:

Contains both upper and lower case characters (for example, a-z and A-Z).

Contains letters, numerals, and punctuation (for example, 0-9 and !@#$%^&*()_+|~ =\`{}[]:";'<>?,/).

Is at least five alphanumeric characters long.

Is not a word in any language and is not slang, dialect, or jargon.

Is not based on personal information, such as the names of family members.

Do not use a weak password:

Contains fewer than eight characters.

Is a word found in a dictionary (English or foreign)

Is any other term that is easily guessed or found in common usage, such as

The name of family, pet, friend, coworker, or fantasy character.

A computing term or name, such as a command, site, company, model, or application.

Is a birthday or another kind of personal information, such as an address or telephone number.

Is a predictable letter pattern or number pattern, such as aaabbb, qwerty, zyxwvuts, or 123321.

Any of the previous spelled backwards.

Any of the previous preceded or followed by a digit, such as secret1 or 1secret.

Using the Call In-Progress Feature

Use this feature, also referred to as activity check, to configure the switch to wait until a Cisco IP phone connected to a PoE port is not sending or receiving traffic before powering off the port.

Use the energywise activitycheck interface configuration command on these Cisco devices:

Catalyst 6500 switches (see the Cisco IOS Release Notes for Cisco EnergyWise, EnergyWise Phase 2 for the specific devices)

Catalyst 4500 switches


Note Before powering off a PoE port, Catalyst 6500 and Catalyst 4500 switches use interface statistics to determine when a Cisco IP phone connected to the PoE port is not sending or receiving traffic.


Catalyst 3750-X, 3750-E, 3750, 3560-X, 3650-E, 3560, and 2960 switches

Cisco EtherSwitch service modules (NME-16ES-1G, NME-16ES-1G-P, NME-X-23ES-1G, NME-X-23ES-1G-P, NME-XD-24ES-1S-P, NME-XD-48ES-2S-P)

Cisco enhanced EtherSwitch service modules (SM-D-ES2-48, SM-D-ES3-48-P, SM-D-ES3G-48-P, SM-ES2-16-P, SM-ES2-24, SM-ES2-24-P, SM-ES3-16-P, SM-ES3-24-P, SM-ES3G-16-P, SM-ES3G-24-P)

Before entering the energywise activitycheck command on devices other than Catalyst 6500 and 4500 switches, you must enable automatic quality of service (auto-QoS) for VoIP on the port with this configuration:

All packets from the IP phone have the class of service (CoS) value 5.

To verify this, use the show mls qos maps cos-output-q privileged EXEC command to display the CoS output queue threshold map.

This example shows that CoS value 5 is mapped to queue 1 and threshold 3 on the Gigabit Ethernet 0/1:

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

This is the configuration for the PoE port:

<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>

Auto-QoS for VoIP is enabled on the PoE port.

Auto-QoS is enabled on the IP phone. The switch does not change the CoS value in the packet from the IP phone.

If the switch is connected to the IP phone through multiple Cisco devices, verify that they trust the CoS value in incoming packets and do not change it.

After entering the energywise activitycheck interface configuration command, verify that the switch powers off the port when a Cisco IP phone connected to it is not sending or receiving traffic. While making a phone call

Run a query to set the port power level to 0. The switch should not power off the IP phone.

Use the show mls qos interface statistics privileged EXEC command to display the port QoS statistics, including the number of packets in queue 1.

PoE and EnergyWise Interactions

Table 1-3 If an Entity Participates in EnergyWise

EnergyWise Entity
 
PoE Mode
 
auto
never
static

PoE port

Yes

No

Yes

Non-PoE port

No

No

No


If the PoE port mode is never, the port power is off, but EnergyWise is not disabled. You can

Configure EnergyWise on the port.

Configure the port power level. The change takes effect after you change the port mode to auto or static. You do not need to restart the switch.

If EnergyWise is disabled, the entity can use PoE to manage the port power usage.

Preventing Network Access to a Non-Cisco End Point

We do not recommend using PC clients running EnergyWise Orchestrator as domain members. In an EnergyWise network, non-Cisco endpoints could have access to the connected IP network and the Internet.

Figure 1-4 PC with Access to the EnergyWise Network and the Internet

1

Domain member

5

Internet

2

Non-Cisco end point running an EnergyWise agent or client

6

DCHP server

3

Layer 2 switch

7

Router

4

Layer 3 switch

8

Management interface SVI 11


For example, in this network, to receive an IP address from the DHCP server, the PC sends a broadcast message to the switches, which forward the message to the Internet. The DHCP server receives the message and assigns an IP address to the PC.

When the PC sends an EnergyWise message to the Layer 2 switch, it forwards the message to the Layer 3 switch instead of responding to it. The Layer 2 switch and the connected PC are in different VLANs. The Layer 3 switch also forwards the message.

If the message is forwarded to the router, the router adds the PC to the router MAC address table as a directly connected device. To prevent this, you can configure a switched virtual interface (SVI) on the Layer 2 switch so that the PC and switch are now in the same VLAN.

The PC now has access to the connected IP network and to the Internet.

When the PC sends messages to the switch, the switch now responds to the messages instead of forwarding them.

The PC can also send messages to and receive messages from the IP network.

Figure 1-5 PC without Access to the EnergyWise Network and the Internet

1

Domain member

5

Internet

2

Non-Cisco end point running an EnergyWise agent or client

6

DCHP server

3

Layer 2 switch

7

Router

4

Layer 3 switch

8

Interface to which ACL 102 is applied


To prevent the PC from accessing the IP network, create and apply an ACL to the ingress interface on the Layer 2 switch. This ACL permits only traffic sent to an IP address of 255.255.255.255 or 20.0.0.1 and to a UDP port of 43440.

Switch(config)# access-list 102 permit udp any any eq 43440
Switch(config)# access-list 102 permit udp any 20.0.0.1 0.0.0.0 eq 43440
Switch(config)# end
Switch# show access-lists
Extended IP access list 102
     10 permit udp any any eq 43440
     20 permit udp any 20.0.0.1 0.0.0.0 eq 43440

Note When you are creating an ACL, remember that, by default, the end of the access list contains an implicit deny statement for all packets if it did not find a match before reaching the end.


CLI Compatibility Issues

EnergyWise Phase 2 is not backward-compatible with EnergyWise Phase 1.


Note Catalyst 6500 switches do not support EnergyWise Phase 1.


To display the EnergyWise version running on your switch, use the show energywise version privileged EXEC command.

To display the software version running on your switch, use the show version privileged EXEC command.


Note If your switch is running EnergyWise Phase 2, enter the no energywise domain global configuration command to disable EnergyWise before downgrading your software to a release supporting EnergyWise Phase 1.


If your switch is running EnergyWise Phase 1 and you upgrade your software to a release supporting EnergyWise Phase 2.

The EnergyWise settings in the running configuration are updated. The switch sets the management password as the same domain password in the energywise domain command.

Enter the copy running-config startup-config privileged EXEC command to save the EnergyWise settings in the configuration file.

For EnergyWise to work properly

All domain members must run either

EnergyWise Phase 1

EnergyWise Phase 2 or later


Note To verify the EnergyWise release, use the show energywise version privileged EXEC command.
The EnergyWise release is referred to as the EnergyWise specification in the command output.


All domain members must have the same domain name and security mode.

If your switch is stacking-capable (for example, a Catalyst 3750-X, 3750-E, or 2960-S switch) and is a member of a switch stack, all the stack members must run the same EnergyWise version.

These commands in EnergyWise Phase 1 were modified:

energywise domain domain-name secret [0 | 7] password global configuration command

We recommend that you reconfigure the EnergyWise domain with the energywise domain domain-name security {ntp-shared-secret | shared-secret} [0 | 7] shared-secret global configuration command.

If you do not reconfigure the domain, the switch synchronizes the management password with the the domain password.

energywise management tcp-port-number global configuration command

We recommend that you reconfigure the management password for the domain with the energywise management security shared-secret [0 | 7] shared-secret port tcp-port-number global configuration command.

For Catalyst 4500-specific issues, see Appendix A, "Cisco EnergyWise and Catalyst 4500 Switches."

For Catalyst 6500-specific issues, see Appendix B, "Cisco EnergyWise and Catalyst 6500 Switches."

Manually Managing Power

Enabling EnergyWise

Configuring Entity Attributes

Powering the PoE Port

Configuring Port Attributes

Enabling EnergyWise

Beginning in privileged EXEC mode:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

service password-encryption

(Optional) Enables password encryption.

If youset a hidden password in Step 3, enter this command.

Step 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]]

Enables EnergyWise on the entity, assigns the entity to a domain with the specified domain-name, sets the domain security mode, and sets the domain password to authenticate all communication in the domain.

ntp-shared-secret—Sets a strong password with NTP. If the time between members varies ±30 seconds, the entity drops events.

shared-secret—Sets a strong password without NTP.

For information about domain security, see the "Secure Domain Communication" section.

(Optional) 0—Uses an unencrypted password. This is the default.

(Optional) 7—Uses a hidden password.

If you do not enter 0 or 7, the default is 0.

(Optional) port udp-port-number—Specifies the UDP port that communicates with the domain.

The range is from 1 to 65000. The default is 43440.

(Optional) interface interface-id—Specifies the port that communicates with the domain if the IP address is dynamically assigned.We recommend that you specify the interface-id. You should use this in a bridged network.

(Optional) ip ip-addressSpecifies the IP address that communicates with the domain if the interface is a switched virtual interface (SVI) and VLAN trunking protocol (VTP) pruning is enabled. You should use this in a routed network.

For the domain-name and domain-password

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

Step 4 

end

Returns to privileged EXEC mode.

Step 5 

show energywise

show energywise domain

Verifies your entries.

Step 6 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Configuring Entity Attributes

Beginning in privileged EXEC mode:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

energywise importance importance

(Optional) Sets the importance.

The range is from 1 to 100. The default is 1.

Step 3 

energywise keywords word,word,...

(Optional) Assigns at least one keyword.

When assigning multiple keywords, separate the keywords with commas, and do not use spaces between keywords.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

By default, keywords are not defined.

Step 4 

service password-encryption

(Optional) Enables password encryption.

If youset a hidden password in Step 5 or Step 10, enter this command.

Step 5 

energywise management security shared-secret [0 | 7] mgmt-password [port tcp-port-number]

(Optional) Sets the management password on the switch that the management station uses to communicate with the domain.

(Optional) 0—Uses an unencrypted password.

(Optional) 7—Uses a hidden password.

If you do not enter 0 or 7, the default is 0.

For the mgmt-password

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

port tcp-port-numberSpecifies the TCP port for management access. The range is from 1025 to 65535. The default is 43440.

By default, the management password is not set.

Step 6 

energywise name name

(Optional) Specifies the EnergyWise-specific entity name.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

The default is the hostname.

Step 7 

energywise neighbor [hostname| ip-address] udp-port-number

(Optional) Assigns a static neighbor.

(Optional) Domain Name System (DNS) hostname (hostname) or IP address (ip-address).

UDP port (udp-port-number) that sends and receives queries. The range is from 1 to 65000.

By default, static neighbors are not assigned.

Step 8 

energywise role role

(Optional) Specifies the role of the entity in the EnergyWise domain. For example, lobby.b20.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

The default is the model number.

Step 9 

energywise allow query {save | set}

(Optional) If the switch receives a query from the management station or another domain member, configures the switch to

save—Responds to a query to save the running configuration.

set—Responds to a query to change the power level or the EnergyWise attributes.

By default, the switch responds to the set query.

Step 10 

energywise endpoint security {none | shared-secret [0 | 7] shared-secret}

(Optional) Sets the security mode for an end point.

none—Disables security.

shared-secret—Uses a password for secure communication with the domain member.

(Optional) 0—Uses an unencrypted password.

(Optional) 7—Uses a hidden password.

If you do not enter 0 or 7, the default is 0.

For the shared-secret

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

By default, the password is not set.

Step 11 

end

Return to privileged EXEC mode.

Step 12 

show energywise

show energywise domain

Verifies your entries.

Step 13 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Powering the PoE Port

Beginning in privileged EXEC mode:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

interface interface-id

Specifies the port or the range of ports to be configured, and enters interface configuration mode.

Step 3 

energywise level level

Manually powers on the port.

For a connected PoE end point, enter a power level of 10.

For an non- PoE-capable end point, enter a power level from 1 to 10. The end point determines the appropriate action.

Step 4 

end

Returns to privileged EXEC mode.

Step 5 

show energywise domain

show energywise children

Verifies your entries.

Step 6 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Note The power level that you set in Step 3 is the default power level when the switch restarts.

Configuring Port Attributes


Note The energywise activitycheck command is supported on

Catalyst 6500 switches (see the Cisco IOS Release Notes for Cisco EnergyWise, EnergyWise Phase 2 for the specific devices)

Catalyst 4500, 3750-X, 3750-E, 3750, 3560-X, 3560-E, 3650, 2960-S and 2960 switches

Cisco EtherSwitch service modules (NME-16ES-1G, NME-16ES-1G-P, NME-X-23ES-1G, NME-X-23ES-1G-P, NME-XD-24ES-1S-P, NME-XD-48ES-2S-P)

Cisco enhanced EtherSwitch service modules (SM-D-ES2-48, SM-D-ES3-48-P, SM-D-ES3G-48-P, SM-ES2-16-P, SM-ES2-24, SM-ES2-24-P, SM-ES3-16-P, SM-ES3-24-P, SM-ES3G-16-P, SM-ES3G-24-P)


Beginning in privileged EXEC mode:

 
Command
Purpose

Step 1 

configure terminal

Enters global configuration mode.

Step 2 

interface interface-id

Specifies the port or the range of ports to be configured, and enters interface configuration mode.

Step 3 

energywise importance importance

(Optional) Sets the importance value of the port.

The range is from 1 to 100. The default is 1.

Step 4 

energywise keywords word,word,...

(Optional) Assigns at least one keyword for the port.

When assigning multiple keywords, separate the keywords with commas, and do not use spaces between keywords.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

By default, keywords are not defined.

Step 5 

energywise name name

(Optional) Specifies the EnergyWise-specific port name.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

The default is a short version of the port name; for example, Gi1.0.2 for Gigabit Ethernet 1/0/2.

Step 6 

energywise role role

(Optional) Specifies the role of the port in the domain. For example, lobbyport.

You can enter alphanumeric characters and symbols such as #, (, $, !, and &.

Do not enter an asterisk (*) or a blank space between the characters or symbols.

By default, the role is interface.

Step 7 

 

(Optional) Before entering the energywise activitycheck command

Verify that auto-QoS is enabled on the port and on the connected IP phone.

If the switch is connected to the IP phones through multiple Cisco devices, verify that they trust the CoS value in incoming packets.

For information about the auto-QoS configuration, see the "Using the Call In-Progress Feature" section in the "Managing Single Entities" chapter.

To configure auto-QoS, see the software documentation for your Cisco network device.

Step 8 

energywise activitycheck

(Optional) Verifies that the connected IP phone is not sending or receiving traffic before the switch powers off the port.

Note The switch cannot determine if the IP phone is in the hold state.

To verify that the command takes effect, see the "Auto-QoS and EnergyWise Interactions" section in the "Managing Single Entities" chapter.

Step 9 

energywise allow query set

(Optional) 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 switch responds to this query.

Step 10 

end

Returns to privileged EXEC mode.

Step 11 

show running-config

Verifies your entries.

Step 12 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Configuring Recurring Events

Beginning in privileged EXEC mode:

 
Command
Purpose

Step 1 

show energywise

(Optional) Verifies that EnergyWise is enabled.

Step 2 

configure terminal

Enters global configuration mode.

Step 3 

time-range time-range-name

(Optional) Assigns a name to the time range, and enter 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.

If EnergyWise is not running on the end point (for example, a PoE end point), the specified times are based on the switch time zone.

If an agent or client is running on the end point, the specified times are based on the end-point time zone.

Use the absolute and the periodic time-range configuration commands to specify times and days for a recurring event. You can use one absolute condition and multiple periodic conditions.

If your absolute or periodic condition has an end time and day, the switch ignores these values.

Step 4 

absolute start hh:mm day_of_month month year

(Optional) Sets the start time and day for the recurring event.

hh:mm—Specifies the time (24-hour format) in hours and minutes.

For example, 08:14 for 0814 and 20:55 is 2055.

day month year—Specifies the date.

day_of_month—The range is from 1 to 31. Use * for the wildcard.

month—The range is from January to December. Use * for the wildcard.

year—The minimum year is 1993.

Step 5 

periodic days_of_the_week hh:mm

(Optional) Sets the weekly start time and day for the recurring event.

days_of_the_week—Valid values are

Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, or Sunday—Enter a single day, a range of days with a dash between the starting and ending days, or multiple days separated by a comma

daily—Enter if the recurring event starts from Monday to Sunday.

weekdays—Enter if the recurring event starts from Monday to Friday.

weekend—Enter if the event occurs on Saturday and Sunday.

hh:mm—Specifies the time (24-hour format) in hours and minutes.

For example, 08:47 for 0847 and 23:05 is 2305.

Step 6 

interface interface-id

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}

(Optional) Schedules a power-on or power-off event.

level level —Specifies the power level

To power off the end point, enter 0.

To power on the end point

If it is a PoE end point, enter 10.

If it is another powered device, enter a power level from 1 to 10. The end point determines the appropriate action.

importance importance—The event occurs if the importance value of the end point is less than or equal to the importance value. The range is from 1 to 100.

at minute hour day_of_month month day_of_week—Specifies the time (24-hour format) in cron format for the recurring event.

minute—The range is from 0 to 59. Use * for the wildcard.

hour—The range is from 0 to 23. Use * for the wildcard.

day_of_month—The range is from 1 to 31. Use * for the wildcard.

month—The range is from 1 (January) to 12 (December). Use * for the wildcard.

day_of_week—The range is from 0 (Sunday) to 7 (Sunday). Use * for the wildcard.

time-range time-range-nameSpecifies the time range for the recurring event.

The event uses the switch time.

Repeat this step to schedule another event.

Step 8 

end

Returns to privileged EXEC mode.

Step 9 

show energywise recurrence

Verifies your entries.

Step 10 

copy running-config startup-config

(Optional) Saves your entries in the configuration file.

Disabling EnergyWise

Table 1-4 EnergyWise Commands 

Command
Mode
Purpose

clear energywise neighbors

Privileged EXEC

Deletes the discovered neighbors and end points running agents or clients from the EnergyWise neighbor table. The switch immediately rediscovers them.

no energywise

Interface configuration

Disables EnergyWise on the PoE port or on the end point.

no energywise activitycheck

Interface configuration

Configures the switch to not wait until a Cisco IP phone connected to a PoE port is not sending or receiving traffic before the switch powers off the port.

no energywise allow query set

Global configuration

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 allow query save

Global configuration

Configures the switch to not respond to a query that saves the running configuration.

no energywise allow query set

Interface configuration

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 domain

Global configuration

Disables EnergyWise on the domain member.

no energywise endpoint

Global configuration

Configures the switch to not establish parent-child relationships with connected EnergyWise-compatible end points. The end points cannot receive queries or messages from the switch.

no energywise [importance | keywords [word,word,... ] | level | name [name] | role [role]]

Interface configuration

Removes the EnergyWise configuration on a switch port.

If you enter the no energywise level command, the switch does not immediately change the power level to the default. The power level changes when the switch restarts or you enter the energywise level level command.

no energywise {importance | keywords [word,word,...] | name | neighbor [hostname | ip-address] udp-port-number | role}

Global configuration

Removes the EnergyWise configuration on the entity.

no energywise level level recurrence importance importance {at minute hour day_of_month month day_of_week | timerange timerange-name}

Interface configuration

Removes the recurring event configuration on a switch port.

no energywise management

Global configuration

Configures the switch to not communicate with a connected management station that sends queries.


Examples

Setting the Domain

Manually Managing Power

Automatically Managing Power


Note 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.


Setting the Domain

Switch# show energywise
Interface   Role              Name                  Usage      Lvl   Imp  Type
---------   ----              ----                  -----      ---   ---  ----
            fanfare           jsmith                1009.0(W)  5     100  paren
Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# energywise domain cisco security ntp-shared-secret cisco protocol udp port 
43440 ip 2.2.4.30
Switch(config)# energywise importance 50
Switch(config)# energywise keywords lab1,devlab 
Switch(config)# energywise name LabSwitch
Switch(config)# energywise neighbor member1 43440
Switch(config)# energywise role role.labaccess
Switch(config)# energywise allow query save
Switch(config)# end
Switch# show energywise domain 
Name      : member1
Domain    : cisco
Protocol  : udp
IP        : 2.2.2.21
Port      : 43440
Switch# 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

Manually Managing Power

To power on the lab IP phones:

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# energywise domain cisco security shared-secret cisco protocol udp port 
43440 ip 2.2.4.44
Switch(config)# interface gigabitethernet0/3
Switch(config-if)# energywise importance 65
Switch(config-if)# energywise name labphone.5
Switch(config-if)# energywise role role.labphone
Switch(config-if)# end

To power off anIP phone connected to a PoE port:

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# energywise domain cisco security shared-secret cisco protocol udp port 
43440 ip 2.2.4.44
Switch(config)# interface gigabitethernet0/2
Switch(config-if)# energywise importance 65
Switch(config-if)# energywise name labphone.5
Switch(config-if)# energywise role role.labphone
Switch(config-if)# energywise level 0
Switch(config-if)# end

The switch powers the IP phone regardless of whether or not EnergyWise is enabled.

Automatically Managing Power

The lab IP phones automatically power on at 0800 and power off at 2000.

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# energywise domain cisco security shared-secret cisco protocol udp port 
43440 ip 2.2.4.30
Switch(config)# interface gigabitethernet1/0/3
Switch(config-if)# energywise level 10 recurrence importance 90 at 0 8 * * *
Switch(config-if)# energywise level 0 recurrence importance 90 at 0 20 * * *
Switch(config-if)# energywise importance 50
Switch(config-if)# energywise name labInterface.3
Switch(config-if)# energywise role role.labphone
Switch(config-if)# end

Switch# 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: *

Switch# 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> 

The PCs on the first floor automatically power on at 0600 and power off at 2000.

Switch# configure terminal
Enter configuration commands, one per line.  End with CNTL/Z.
Switch(config)# energywise domain cisco security shared-secret cisco protocol udp port 
43440 ip 2.2.4.30
Switch(config)# time-range onfirstfloor
Switch(config-time-range)# absolute start 0:00 1 August 2009
Switch(config-time-range)# periodic weekdays 6:11 
Switch(config-time-range)# periodic weekend 9:37
Switch(config)# time-range offfirstfloor
Switch(config-time-range)# absolute start 0:00 1 August 2009
Switch(config-time-range)# periodic weekdays 20:19 
Switch(config-time-range)# periodic weekend 18:59
Switch(config)# interface gigabitethernet0/3
Switch(config-if)# energywise level 10 recurrence importance 70 time-range onfirstfloor
Switch(config-if)# energywise level 0 recurrence importance 70 time offfirstfloor
Switch(config-if)# energywise name floor.1
Switch(config-if)# energywise role pc-mgr
Switch(config-if)# end

Switch# show energywise recurrences 
Id     Addr       Class Action Lvl Cron
--     ----       ----- ------ --- ----
1      Gi0/3      QUERY SET    10  onfirstfloor
2      Gi0/3      QUERY SET     0  offfirstfloor

Switch# 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> 

If the time range has end times and days such as

Switch(config)# time-range offfirstfloor
Switch(config-time-range)# absolute start 0:00 1 August 2009 23:58 31 December 2011
Switch(config-time-range)# periodic monday 20:01 friday 23:55
Switch(config-time-range)# periodic saturday 18:05 sunday 23:30

Note EnergyWise uses only the start time in the time range. EnergyWise ignores any configured end time.