Guest

Support

Cisco EnergyWise Orchestrator Proxy Configuration Editor User Guide

  • Viewing Options

  • PDF (351.6 KB)
  • Feedback
Cisco EnergyWise Orchestrator Proxy Configuration Editor User Guide

Table Of Contents

Cisco EnergyWise Orchestrator Proxy Configuration Editor User Guide

Contents

System Requirements

Getting Started

Related Documentation

Obtaining Documentation and Support on the Cisco Developer Network

Obtaining Documentation, Support, and Security Guidelines


Cisco EnergyWise Orchestrator Proxy Configuration Editor User Guide


April, 2011

Unless otherwise noted, the terms network device and device refer to Cisco switches, routers, access points and other network devices.

For information about a specific Cisco device running Cisco EnergyWise Phase 2, see the release notes for the Cisco IOS software running on your device. To verify that these release notes are correct for your switch, use the show version privileged EXEC command.

For the list of EnergyWise Phase 2 documentation, see the "Related Documentation" section.

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 "Importance Notice" appendix in the Cisco EnergyWise Orchestrator guides:
http://www.cisco.com/en/US/products/ps10195/tsd_products_support_series_home.html

Contents

System Requirements

Getting Started

Related Documentation

Obtaining Documentation and Support on the Cisco Developer Network

Obtaining Documentation, Support, and Security Guidelines

System Requirements

Orchestrator Server version 2.0.0 uses these Microsoft SQL Server versions for data storage:

U.S. English SQL Server 2005 x86 SP2

U.S. English SQL Server 2008 x86 SP1

The Orchestrator Agent runs on

Windows 7 x86 and the latest patches

Windows 7 x64 and the latest patches

Windows Vista x86 SP2 and the latest patches

Windows XP x86 SP3 and the latest patches

The Orchestrator Administration Console and the Sustainability Dashboard run on Internet Explorer 7 and Flash Player 10.

Software requirements for the Orchestrator Server:

Microsoft IIS 6.0

.NET 3.5 SP1

Java 6 update 17

Getting Started

The Cisco EnergyWise Orchestrator Proxy Configuration Editor is a Windows GUI application for editing the Proxy Server web.config file. The web.config file contains EnergyWise domain information for each domain. Orchestrator uses this information to configure the EnergyWise proxy server with the information needed to manage EnergyWise domains.

The Proxy Configuration Editor comprises two files:

proxycfg.exe

EnergyWiseConfiguration.dll

Install the Proxy Configuration Editor on the server where the Orchestrator Server version 2.0.0 and the Provisioning Server are installed.


Step 1 Download the.zip file that contains the proxycfg.exe and EnergywiseConfiguration.dll files:

http://orchestratorkb.verdiem.net/file_downloads/CiscoEnergyWiseOrchestrator_2.0.0_Enhancements.zip

Step 2 Copy the files to the C:\Inetpub\wwwroot\Cisco Systems\EnergyWiseProvisioningService\bin directory.

Step 3 Run the proxycfg.exe file.

Open the web.config file by clicking File > Open and then selecting the web.config file in the C:\Inetpub\wwwroot\Cisco Systems\EnergyWiseProvisioningService directory.


Note Make a backup copy of the web.config file before editing it.


The window shown in Figure 1 appears.


Note When you open the web.config file in a new installation, a sample entry appears that shows examples of the values that you need to enter. Be sure to delete that entry after you add your EnergyWise domains.


Figure 1 Proxy Configuration Editor Main Screen

Step 4 Select a proxy server, and click Edit Proxy Installation to display the Edit Proxy Installation window (Figure 2).

Figure 2 Edit Proxy Installation Window

In this window, you can enter or change values for the parameters shown. See Table 1 for guidelines and valid values.

Table 1 Proxy Server Parameters and Allowed Values

Parameter
Allowed Values

Proxy Identifier

The name of the Orchestrator proxy server. The default value for Proxy Identifier is ProxyInstanceID-1. The name must match the name specified during the proxy server installation.

Note If you use multiple Orchestrator EnergyWise proxy servers, each server must have a unique identifier.

This value is also stored in the energywise-proxy.properties file on the computer where the Orchestrator EnergyWise proxy server is installed. (This file is typically stored in the C:\Program Files\Cisco Systems\EnergyWiseProxyServer\energywise-proxy.properties directory.)

Authorized User

The Windows service account running the EnergyWise Proxy Service. This account is listed in the Services Control Panel in the Log On As column.

Note If the EnergyWise Proxy Service is running as Network Service, specify NT AUTHORITY\NETWORK SERVICE as the user.

Hostname

The IP address or host name of the server on which the EnergyWise Proxy Service is installed.

If you will be using only a primary proxy server, you can enter localhost or the loopback IP address 127.0.0.1 as the host name.

If you are using this proxy server with an EnergyWise domain that has a secondary proxy server, do not use the IP loop back address 127.0.0.1 or localhost for the host name.


Step 5 Click OK to accept the settings.

Step 6 Click Add EnergyWise Domain to add a domain. Click Edit EnergyWise Domain to edit an existing domain and display the Edit EnergyWise Domain window (Figure 3).

Figure 3 Edit EnergyWise Domain Window

In this window, you can define the domain configuration parameters and the association between the proxy server and the domain. See Table 2 and Table 3 for guidelines and valid values.

Table 2 EnergyWise Domain Settings 

Parameter
Value

Domain Name

Enter the EnergyWise domain name currently configured on the device used to manage the domain.

Note This is the name you configured by using the energywise domain domain_name global configuration command.

Primary Management Switch

Enter the IP address of the EnergyWise-enabled device used by the proxy servers to manage the EnergyWise domain.

Note You must first configure this device with the EnergyWise domain shared management secret.

Secondary Management Switch (optional)

Enter the IP address of a backup EnergyWise-enabled domain management device.

Note You must first configure this device with the EnergyWise domain shared management secret.

If you are not using a secondary management switch, leave this field blank.

Shared Endpoint Secret

Enter the end point secret key for the domain configured on the device.

Configure this key by using the energywise endpoint security shared secret endpoint_secret global configuration command.

Shared Management Secret

Enter the EnergyWise management secret key for the domain configured on the device. This is the management password on the switch used by the management station to communicate with the EnergyWise domain.

Configure this key by using the energywise management security shared secret 0 mgmt_secret global configuration command.

Management Port

Enter the TCP port to be used for management access. The default port is 43440. Valid values are 1025 through 65535.

Configure this value by using the energywise management security shared secret 0 domain_secret port tcp_port global configuration command.

Query Timeout (seconds)

Enter the interval (in seconds) that a proxy server waits for a response to an EnergyWise query. The range is from 1 to 180. We recommend using the default value of 10 seconds to ensure stable operation.


Table 3 Orchestrator Proxy Server Settings

Component
Settings

Primary Proxy Server

The proxy identifier of the primary proxy server for this EnergyWise domain. The proxy identifier must match a previously-defined proxy installation.

Secondary Proxy Server

The proxy identifier of the backup proxy server for this EnergyWise domain. The proxy identifier must match a previously-defined proxy installation.

Note If you are specifying a secondary proxy server, do not use the IP loop back address 127.0.0.1 or localhost for the host name of either the primary or secondary proxy server.

Collection Interval (seconds)

Enter the interval (in seconds) between proxy server queries to the EnergyWise domain for status and energy use. We recommend using the default value of 900 seconds (15 minutes) as a minimum interval for production deployments.


Step 7 Click OK to accept the settings.

Step 8 From the File menu, select Save to save your configuration (Figure 4).

Figure 4 Proxy Configuration Editor File Menu

Step 9 Exit the Proxy Configuration Editor by clicking File > Exit, by simultaneously pressing the Control key and the x key, or by clicking the red X in the upper right corner of the window.

Step 10 Use the Windows Services console to restart the EnergyWise Proxy Service.


Note Whenever you make a change to the web.config file on the EnergyWise provisioning server, you must restart the EnergyWise Proxy Service to enable the changes.


Related Documentation

Configuring Cisco network devices:

Cisco EnergyWise Configuration Guide:
http://www.cisco.com/en/US/docs/switches/lan/energywise/phase2/ios/configuration/guide/
ew_v2.html

Cisco IOS Release Notes for Cisco EnergyWise, EnergyWise Phase 2:
http://www.cisco.com/en/US/docs/switches/lan/energywise/phase2/ios/release/notes/
OL19810.html

Configuring Cisco EnergyWise Feature for Branch Routers:
http://www.cisco.com/en/US/docs/routers/access/1900/software/configuration/guide/enrgyz_artg.html

Cisco EnergyWise IOS Deployment Guide:
http://www.cisco.com/en/US/products/ps10195/prod_configuration_examples_list.html

Cisco EnergyWise Orchestrator guides:
http://www.cisco.com/en/US/products/ps10195/tsd_products_support_configure.html

Cisco EnergyWise Orchestrator Administrator Guide, Cisco EnergyWise Phase 2

Cisco EnergyWise Orchestrator Installation Guide, Cisco EnergyWise Phase 2

Cisco EnergyWise Orchestrator Wake for Remote Access Administrator Guide, Cisco EnergyWise Phase 2

These partner documents provide information about the management API and end point SDK and are available on the Cisco Developer Network:
http://developer.cisco.com/web/esdk/home.

Cisco EnergyWise Documentation Roadmap

Cisco EnergyWise Partner Development Guide

Cisco EnergyWise Programmer Reference Guide for the End-Point SDK

Cisco EnergyWise Programmer Reference Guide for the Management API

Obtaining Documentation and Support on the Cisco Developer Network

Cisco EnergyWise development partners can access the EnergyWise documents, API and SDK software code, and Cisco IOS software by joining the Cisco Developer Network:
http://developer.cisco.com/web/esdk/home.

You need a support contract and license to access EnergyWise resources on the Cisco Developer Network and on TAC. The business development manager who registered your licence must set up your Cisco.com account with the appropriate access privileges.

The forum, wiki, and other resources on the Cisco Developer Network provide a self-help knowledge base and community for EnergyWise application developers and programmers. You can get additional support by opening a case in the TAC Service Request Tool:
http://tools.cisco.com/ServiceRequestTool/create/launch.do.

Obtaining Documentation, Support, and Security Guidelines

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed, and set content to be delivered directly to your desktop by a reader application. The RSS feeds are a free service, and Cisco supports RSS version 2.0.