- Preface
- Introduction to Cisco EnergyWise Orchestrator
- Managing Administrative Groups
- Security and Permissions in the Orchestrator System
- Managing and Viewing Devices
- Managing Policies
- Waking Computers
- Viewing Reports
- Getting Diagnostic Information from Event Logs
- Sustainability Dashboard
- Troubleshooting
- Important Notice
- Understanding Device Management
- Configuring Devices for Cisco EnergyWise
- Devices, Policies, and Power Level Settings
- Device Connections and Check-Ins
- Devices Checking In
- Devices and Groups
- Viewing Device Information
- Device Properties and EnergyWise Attributes
- Power States and Activity
- Device Charts
- Device Attributes and Properties
Managing and Viewing Devices
•
Understanding Device Management
–Configuring Devices for Cisco EnergyWise
–Devices, Policies, and Power Level Settings
–Device Connections and Check-Ins
–Device Properties and EnergyWise Attributes
–Device Attributes and Properties
•Displaying Device Information
Understanding Device Management
A device in Orchestrator can be a PC or an EnergyWise-enabled router, switch, IP phone, or wireless access point (WAP).
Orchestrator collects data on all connected devices for reporting purposes. You can see how much energy is used by each device, why, and at what times of day users are most active.
Orchestrator begins collecting data for all devices as each device connects to the system. The data updates each time a device checks in.
Note The frequency for device check-in and how Orchestrator staggers check-ins is set in Server Configuration under Device check-in internal (Server menu).
On the Manage Devices page in the Administrator Console, you can:
•Display devices according to broad or specific search and filtering criteria.
•Control device power states and levels directly outside of a policy.
•Assign policies to devices.
•Assign devices to groups.
•Edit PC properties and EnergyWise device attributes.
•Manage Wake on WAN proxies.
•Run policy or group assignment rules.
•See reports on device activity and type, policy assignment, and group membership.
Configuring Devices for Cisco EnergyWise
Orchestrator recognizes EnergyWise devices based on the domains that you specify in the EnergyWise provisioning server configuration file.
For details on enabling EnergyWise devices in Orchestrator, see the "Configuring Orchestrator for EnergyWise devices" chapter in the Cisco EnergyWise Orchestrator Installation Guide.
Devices, Policies, and Power Level Settings
Each device can have only one assigned policy, but each policy can contain multiple schemes and power state changes, each with its own schedule.
Note Scheduled power schemes cannot overlap.
You can assign a policy to a device, either manually from the Assign Policies menu on the Manage Devices page or through assignment rules that you create (Devices > Configure Policy Assignment Rules).
Note All power settings in policies apply to PCs. For other types of devices, only scheduled power level changes apply. Orchestrator collects data for all device types for reporting purposes.
Outside of a policy, you can apply power state changes to any device and change EnergyWise device attributes or PC device properties either individually or as a set.
Device Connections and Check-Ins
When a device connects to the Orchestrator server for the first time, or whenever a device reestablishes contact with the server after being out of contact for a specified period of time, the server and client PC exchange a series of queries and responses referred to as a handshake. During a handshake, the server:
•Sends a query for the device GUID, netBIOS, MAC address, and policy version.
•Evaluates PCs as Wake on WAN proxies.
•Evaluates group and policy assignment rules.
•Compares its policy version with the policy version reported by the device.
PCs and EnergyWise devices (via the proxy server) send a message to the server the first time they connect to the Orchestrator server, or any time they attempt to reestablish contact with the server after being out of contact with the server for a period of time.
A PC will send this message when it: starts up, reboots, transitions out of sleep or a low power state to on, reestablishes network connectivity after being disconnected from the network (i.e., when the PC is out of contact with the server for any reason, for a period of time, and then reestablishes network connectivity).
Devices Checking In
PC devices check in with the Orchestrator server based on the Device check-in interval setting on the Configure Server Settings page. Each time the client checks in, the server records the time.
If a device misses two consecutive check-in times, the Orchestrator server marks the device as Not checking in. When the device checks in again, the Orchestrator server sets the device status to Checking in.
Note Whether a device is checking in or not is not related to its power state or whether the device is on or off. It is an indication that the device is communicating with the server.
In the case of EnergyWise devices, a device can be checking in even when it is at power level 0 (Off) because the device is still present in the EnergyWise domain.
When the EnergyWise proxy server is managing devices, a device is considered Not checking in if the proxy server is stopped, or if the proxy server polls a domain and the device is no longer present in the domain.
Table 4-1 describes the communication that takes place between Orchestrator and PC clients and EnergyWise devices when devices connect to, and check in, with Orchestrator.
Devices and Groups
You can assign devices to groups, either manually or through assignment rules that you create (Devices > Configure Group Assignment Rules). A device can only be assigned to one group at a time.
Viewing Device Information
All device attributes and information can be accessed on the Manage Devices page in the Administrator Console. You can display and search for any device, by group, by policy, by device family, or by PC subnet. All devices that meet the filter or search criteria appear in the device list.
Note By default, the device list displays the first 2000 devices that meet the search and filter criteria. If you need to see a larger set of devices, in the Server menu, click Configure Server Settings, and increase the Max items per search result value. The maximum value allowed is 20,000. Setting this value to a higher number can result in longer display times for search results.
•Click the Customize View button on the Manage Devices page to add columns or remove columns from the view.
•Change the order of columns by dragging a column to a new position in the list.
•Click the Charts tab to see a high-level picture of device activity and membership.
The chart data is based on the current result set of devices being viewed in the device list (2000 by default). For a representative sample of devices in the charts, you might need to increase the Max items per search result value on the Configure Server Settings page.
Click the Reports menu to display details on operational state, user activity, and event log information for devices.
Device Properties and EnergyWise Attributes
The Orchestrator server stores device properties and EnergyWise attributes for each device that connects to the server. (Some fields might not be populated for devices in some device families.) Some device attributes are created by the server, and some are reported by the device.
•The Orchestrator agent software reports attributes for PCs.
•The Orchestrator Proxy Server reports attributes for EnergyWise-enabled devices (switches, routers, IP phones, and wireless access points).
For a complete list of device properties and attributes, see the "Device Properties and EnergyWise Attributes" section.
For information on customizing the device list to show certain attributes and properties, see the "Viewing Devices and Attributes" section.
For details on changing device attributes or properties in Orchestrator, see the "Setting Device Properties and Attributes" section.
Power States and Activity
Orchestrator tracks different power states for PCs compared to other devices.
PCs:
•On
•Idle
•Sleep
•Hibernate
•Off
Monitors:
•Low power
•On
•Off
Orchestrator tracks user activity, including mouse clicks, keyboard touches, and any hard disk or processor activity.
Orchestrator tracks and enforces power state changes on PCs:
•Wake
•Sleep
•Hibernate
•Shut down
•Restart
•EnergyWise power levels that map to wake, sleep, hibernate, and shut down (if configured for EnergyWise support).
Note PC clients always respond to EnergyWise power levels set through the Administrator console.
Orchestrator tracks and manages power levels for EnergyWise-enabled devices (including PCs):
•Levels 3 to 10—Wake or On
•Level 2—Sleep
•Level 1—Hibernate
•Level 0—Shut down or Off
Note The default power level is 10. A Cisco switch does not support level 0. You cannot turn off the power to a switch.
Device Charts
The Charts tab on the Manage Devices page provides charts with high-level pictures of device activity and membership based on the current result set of devices.
Note The chart data is based on the devices being viewed in the device list (2000 by default). For a representative sample of devices in the charts, you might need to increase the Max items per search result value on the Configure Server Settings page.
See the "Displaying Device Information" section.
Device Attributes and Properties
The Orchestrator server stores device properties and EnergyWise attributes for each device that connects to the server. (Some fields might not be populated for devices in some device families.) You can see device properties and attributes in the Orchestrator Administrator console on the Manage Devices page (Devices menu > Filtered Search). Some device attributes are created by the server, and some are reported by the device. The Orchestrator agent software reports attributes for PCs. The Orchestrator Proxy Server reports attributes for non-PC devices (switches, routers, IP phones, and wireless access points).
For a complete list of device properties and attributes, see the "Device Properties and EnergyWise Attributes" section.
For information on customizing the device list to show certain attributes and properties, see the "Viewing Devices and Attributes" section.
For details on changing device attributes or properties in Orchestrator, see the "Setting Device Properties and Attributes" section.
Attribute and Property Descriptions
•Table 4-2: Default Attributes and Properties
•Table 4-3: EnergyWise Attributes and Properties
•Table 4-4: Advanced Attributes and Properties
•Table 4-5: Troubleshooting Attributes and Properties
Table 4-3 table describes EnergyWise attributes and properties.
Table 4-4 table describes the advanced attributes and properties.
Table 4-5 table describes the troubleshooting attributes and properties.
Displaying Device Information
•Viewing Devices and Attributes
•Excluding Interfaces from the Device List
•Excluding Unlicensed Devices from the Device List
Viewing Devices and Attributes
Use the Manage Devices page to access device information. You can search for and display devices based on a variety of attributes, including by group, by policy, by device family, or by PC subnet. All devices meeting the filter or search criteria appear in the device list.
For a list of device attributes and properties, see the "Device Properties and EnergyWise Attributes" section.
Orchestrator provides many options to see devices. You can go to tab views that filter devices based on group, policy, or subnet (displays only PCs on the selected subnet). You can also use the search function to filter by group, policy, subnet (PCs only), and device family.
Note By default, the device list displays the first 2000 devices that meet the search and filter criteria. If you need to see a larger set of devices, in the Server menu click Configure Server Settings, and increase the Max items per search result value. The maximum value allowed is 20,000. Setting this value to a higher number can result in longer display times for search results.
•Click Customize View on the Manage Devices page to add columns to or remove columns from the view.
•Change the order of columns by dragging a column to a new position in the list.
•Click the Charts tab to see a high-level picture of device activity and membership.
Note•The chart data is based on the current result set of devices being viewed in the device list (2000 by default). For a representative sample of devices in the charts, you might need to increase the Max items per search result value on the Configure Server Settings page.
•Click the Reports menu to display details on operational state, user activity, and event log information for devices.
•To display only devices that are currently licensed, select Exclude devices with licensing disabled in the device lists on the Configure Server Settings page (on the Server menu, click Configure Server Settings).
•Devices that appear as Interface in the device list are ports with no IP phones, wireless access points, or other PoE devices plugged into them. To hide interfaces from the device list, select Do not display Interface devices in the device lists on the Configure Server Settings page (on the Server menu, click Configure Server Settings).
To see device information:
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or Subnets) that you want to use to filter the display, and select a filter on that tab to see the results in the device list.
You can also click the Search tab, select options in the device filters to display the set of devices that you want, and enter a search string.
Step 3 Click Search to see the results set in the device list.
Note To see only licensed devices, select Exclude devices with licensing disabled in the device lists on the Configure Server Settings page. On the Server menu, click Configure Server Settings.
Devices that appear as Interface in the device list are empty ports (ports with no end points).
To hide interfaces from the device list, select Do not display Interface devices in the device lists on the Configure Server Settings page. On the Server menu, click Configure Server Settings.
Excluding Interfaces from the Device List
Devices that appear as Interface in the device list are ports with no IP phones, wireless access points, or other PoE devices plugged into them.
To hide empty ports in the device list, select Do not display Interface devices in the device lists on the Configure Server Settings page.
Step 1 On the Server menu in the Administrator console, click Configure Server Settings.
Step 2 Check the Do not display Interface devices in the device lists check box.
Step 3 Click Save.
For information on viewing devices, see the "Viewing Devices and Attributes" section.
Excluding Unlicensed Devices from the Device List
To see only the licensed devices in the device list, you can select Exclude devices with licensing disabled in the device lists on the Configure Server Settings page.
For information on removing a device or disabling its licensing, see the "Removing a Device from the System" section.
Step 1 On the Server menu, click Configure Server Settings.
Step 2 Check the Exclude devices with licensing disabled in the device lists check box.
Step 3 Click Save.
For information on viewing devices, see the "Viewing Devices and Attributes" section.
Managing Devices
•Assigning Policies to Devices
•Setting Device Properties and Attributes
•Removing a Device from the System
Assigning Devices to Groups
You can assign devices to groups from the device list or automatically by using group assignment rules.
For details on configuring group assignment rules, see the "Configuring Group Assignment Rules" section on page 2-3.
For details on creating groups, see the "Creating Administrative Groups" section on page 3-2.
Follow these steps to manually assign a device to a group:
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or Subnets) that you want to use to filter the display, and select a filter option for seeing the results in the device list.
(Optional) Click the Search tab, select different options in the device filters to display the set of devices that you want, and enter a search string.
Step 3 Click the Search button to see the results in the device list.
Step 4 Select the device or devices in the list.
Step 5 On the Move to Group menu, click Manually Assign Group, or click Use Group Assignment Rules.
Note When you manually assign a policy to a device, it is flagged as a manual assignment. To clear the flag, select the device from the device list. On the Move to Group menu, click Use Group Assignment Rules.
If you choose Use Group Assignment Rules and one or more selected devices was manually assigned, select Include N manually assigned devices and click OK to confirm that you want to change from a manually assigned group to rule-based assignment.
Step 6 For manual assignment, click the group name, and click OK.
Step 7 For rule-based assignment, click OK.
Assigning Policies to Devices
You can assign policies to devices in device list or automatically by using policy assignment rules.
Note All power settings in policies apply to PCs. For other types of devices, only scheduled power level changes apply. For non-PC devices, a scheduled power level change might be the only setting that you apply by using a policy.
For details on policy assignment rules, see the "Configuring Group Assignment Rules" section on page 2-3.
For details on creating policies, see the "Creating and Editing Policies" section on page 5-8.
To manually assign policies:
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or Subnets) that you want to use to filter the display, and select a filter option to see the results in the device list.
(Optional) Click the Search tab, select different options in the device filters to display the set of devices you want, and enter a search string.
Step 3 Click the Search button to see the results set in the device list.
Step 4 Select the device or multiple devices in the resulting list.
Step 5 On the Assign Policies menu, click Manually Assign Policy or Use Policy Assignment Rules.
Note When you manually assign a policy to a device, it is flagged as being manually assigned. To clear the flag, select the device from the device list, and then on the Assign Policies menu, click Use Policy Assignment Rules.
If you choose Use Policy Assignment Rules and one or more of the selected devices had been manually assigned, select Include N manually assigned devices and click OK to confirm that you want to change from a manually assigned policy to a rule-based assignment.
Step 6 For manual assignment, click the policy name, and click OK.
Step 7 For rule-based assignment, click OK.
Controlling Devices Directly
You can change the power levels of devices directly from the device list.
For details on enforcing power state changes within policies, see the "Creating and Editing Policies" section on page 5-8.
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or Subnets) that you want to use to filter the display, and select a filter option on that tab to see the results in the device list.
You can also click the Search tab, select different options in the device filters to display the set of devices that you want, and enter an optional search string.
Step 3 Click the Search button to see the results set in the device list.
Step 4 Select the device or devices in the list.
Step 5 On the Set Power Level menu, click a power level.
Note•You can also right-click a device to select a power level from a context menu.
•Set EnergyWise Power Level automatically maps to PC power states. This works for PCs and non-PC devices.
•For PCs only: If you select Sleep, Shut Down, Restart, or EnergyWise Power Level, you can force a change of the power state by selecting Force transition. You can also choose whether to force a state change for Wake on WAN proxies.
•Use Force transition only when necessary. Some applications could block normal Windows shut down requests. For example, Word or Notepad might display a dialog box asking a PC user to save document changes. When you select Force transition, applications cannot block shut down and unsaved changes in the application are lost.
Step 6 (PCs only) Enter and select the options that you want to use for the transition (message, force transition), and click OK.
Note The options for forcing a transition or displaying a message are ignored for non-PC devices.
Step 7 Enter and select the options that you want to use for the transition, and click OK.
Setting Device Properties and Attributes
You can change device properties for PCs (description Wake on WAN), or edit EnergyWise attributes (Role, Keyword, or Importance) from the device list on the Manage Devices page (Devices menu > Filtered Search).
For PC properties, you can specify the ranking for the device as a Wake on WAN proxy. In the Edit Device Properties dialog box, check the Preferred Wake on WAN proxy check box, and select:
•Preferred increases the ranking of the selected computers in the proxy selection criteria.
•Never prevents the selected computers from being selected as proxies.
•Default or Don't change means that other computer attributes are used as selection criteria and only if there are no preferred proxies available.
For other details, see the "Setting a Device As a Preferred Wake on WAN Proxy" section on page 6-8.
For EnergyWise devices, you can edit the Role, Keyword, and Importance attributes for parents (switches) or children (interfaces). You can use the attributes to identify a specific device or a group of devices.
•Use the Role attribute to show the general business context.
•Importance ranges from 1 (least important) to 100 (most important). Use the Importance attribute to differentiate between devices in a domain.
For example, an office phone has a lower importance compared to an emergency phone. Because it is critical that the emergency phone never enter sleep mode, you should set the Importance to 100.
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or PC Subnets) that you want to use to filter the display, and select a filter on that tab to see the results in the device list.
You can also click the Search tab, select options in the device filters to display the set of devices you want, and enter a search string.
Step 3 Click Search to see the results set in the device list.
Step 4 Select the device or devices in the list.
Step 5 On the Edit Devices menu, select Edit device properties or Edit EnergyWise attributes.
Step 6 Enter and select the options that you want to use, and click OK.
Removing a Device from the System
To remove a device from the Orchestrator system or to unlicense a device, you can disable the device license on the Manage Devices page (Edit Devices > Device Licensing > Do not allocate a license to the device). Orchestrator does not collect or report data for any devices with disabled licensing. However, historical data collected while the device was licensed is retained.
Reinstall a device by choosing Allocate a license when one is available in the License devices dialog box.
To see only the licensed devices in the device list, select Exclude devices with licensing disabled in the device lists on the Configure Server Settings page. On the Server menu, click Configure Server Settings.
Step 1 On the Devices menu, click Filtered Search.
Step 2 Click the tab (Groups, Policies, or Subnets) that you want to use to filter the display, and select a filter on that tab to see the results in the device list.
You can click the Search tab, select different options in the device filters to display the set of devices that you want, and then enter a search string.
Step 3 Click the Search button to display the results set in the device list.
Step 4 Select the device or devices in the list.
Step 5 On the Edit Devices menu, click Device Licensing.
Note You can also right-click a device, and click Device Licensing.
Step 6 Click Do not allocate a license to the device, and click OK.
Note You can re-enable a device by choosing the Allocate a license when one is available option in the License Devices dialog box.
Feedback