1. About this guide

This is draft documentation intended for use by testers of a forthcoming release of the service. It may not reflect functionality currently offered by the service

This documentation is intended for end-users of the service to help the to understand its purpose, and how to carry out common tasks. Additional documentation intended for IT Support Staff also exists

2. Introduction to EEM

What is it for?

EEM stands for "Energy and Efficiency Monitoring" and provides two service which are key to reducing the power consumption and carbon emissions:
  • A "Wake-on-lan" service which wakes up computers which have been shut down
  • A monitoring service which collects information about which computers have been left on, which are turned off at various times of the day and night, and calculates power usage
There are three important points to bear in mind:
  • EEM only knows about computers which have been registered with it, individuals and IT Support Staff can register computers
  • EEM is only able to wake up computers if a device known as a gateway has been installed on the local network - IT Officers are responsible for installing these
  • EEM does not (and cannot) turn computers off, which is clearly the most important step in the process. Automated shutdown of computers is possible, but hasn't been widely implemented within the University. It is therefore vital that users turn their computers off when not in use (overnight, for example).

3. Terminology

The EEM service uses of a set of terms, the meaning of which is, at times, specific to EEM. The list below includes both definitions and a summary of the concept that this term represents in EEM.

Table 1. EEM Service Terminology
Machine A machine is a device registered with the EEM service. For EEM to communicate with a machine it should be present on a physical network (waking machines over a wireless network is possible, but not normally supported). In almost all cases a machine will be a computer, although this is not necessarily the case. Please note that not all computers are configured to respond to wake requests, so you should consult your IT Support Services if you are in doubt.
Schedule A schedule is created and a machine assigned to it during manual registration of a machine. More than one machine may be associated with a schedule. Schedules can be assigned wakeups set to wake the machines associated with the schedule at certain times. Schedules can be shared with on or more users who then have the rights to modify the schedule.
Manual Group A manual group is created and has machines assigned to it manually. It can only be used to manually wake machines in the group and no wakeups can be assigned to it
Wakeup A wakeup is a preset time and day(s) on which a wakeup signal is sent to machines in a schedule. One or more wakeups can be added to a schedule.
Manual wakeup A manual wakeup is an wakeup signal sent to all machines in a schedule, or to a single machine on demand when a button is clicked in the web interface.
Use by TSM for backups The TSM backup system which backs data up to HFS sends wakeup signals to machines prior to them being backed up. In order for this to happen the TSM Nodename must be recorded against the machine in EEM. This can be done during or after registration.
MAC address This is a special address which is unique to a network interface in a machine. MAC addresses are assigned during manufacture and cannot, under normal circumstances, be changed.

4. Task-based documentation

All tasks are carried out in the web user interface at https://eem.ox.ac.uk/

4.1. Registering a machine (resulting in the automatic creation of a group)

There are two ways to register a machine, both start from the service home page:

  • Automatically detect the MAC address of the machine
    1. At the home page click "Register a Machine"
    2. Log in through webauth
    3. There will be a short delay (up to 30 seconds) while the MAC address of your machine is detected
    4. If the machine does not already exist in EEM a registration form with the MAC address and friendly name (as found in DNS) pre-filled will be displayed. If the machine is already registered you will be informed and be able to click a link to view details of the machine.
    5. Choose the device class of the machine - this will update the "Watts consumption when idle" which is used to calculate power usage. You can change this manually if you accurately know the power consumption of the machine
    6. Fill in the TSM node name if this machine is backed up to HFS.
    7. Choose whether you want to create a new schedule for this machine (default) or add to to an existing one that is shared with you (please note that this does not affect TSM wakeups). The latter is useful if you have more than one machine and want to be able to wake all of them up with a single click.
    8. Click register
    9. A screen will be displayed to enable you to add a wakeup (see below)
  • Register a machine where the MAC address cannot be detected
    1. A the home page click "manual registration" under "Register a machine"
    2. Log in through webauth
    3. A registration form will be displayed. As a minimum you must fill in the MAC address and friendly name of the machine. To find the MAC address you may find this external guide useful.
    4. Choose the device class of the machine - this will update the "Watts consumption when idle" which is used to calculate power usage. You can change this manually if you accurately know the power consumption of the machine
    5. Fill in the TSM node name if this machine is backed up to HFS.
    6. Choose whether you want to create a new schedule for this machine (default) or add to to an existing one that is shared with you (please note that this does not affect TSM wakeups). The latter is useful if you have more than one machine and want to be able to wake all of them up with a single click.
    7. Click register
    8. A screen will be displayed to enable you to add a wakeup (see below)

4.2. Adding a wakeup to a schedule

Once you have registered a machine you can add one or more wakeups so that the machine is woken by EEM at you chosen time and day.

  1. In the block titled '<your friendly name> schedule' click 'add a wakeup'
  2. Click the time box and enter the time using the popup helper
  3. Choose on which days the wakeup should occur (working days are selected by default)
  4. Add a comment if desired
  5. Click "Save" at the bottom or top of the page

4.3. Deactivating a wakeup

To manually disable a wakeup:

  1. Untick the "Active" box of the wakeup row
  2. Click "Save" at the bottom or top of the page

4.4. Deleting a wakeup

To permanently delete a wakeup:

  1. Click "delete row" at the end of the wakeup row
  2. Click "Save" at the bottom or top of the page

4.5. Adding exceptions to the schedule

Exceptions can be added to the schedule. These apply to all wakeups

  1. Below the wakeups two pre-defined exceptions are listed (Bank Holidays and Outside Term Time), which can be ticked to activate them
  2. An exception can be added manually so that the machine is not woken between two selected dates. Click "add interval" and click the boxes to set the interval. This is useful when you want to prevent you machine from being woken when you are away (on holiday for example)
  3. In either case click "Save" at the bottom or top of the page

4.6. Removing exceptions from a schedule

  1. Pre defined exceptions can be disabled by unticking the boxes
  2. Manually defined exceptions can be deactivated by unticking the box in the exception row, and deleted by clicking "delete" at the end of the exception row
  3. In either case click "Save" at the bottom or top of the page

4.7. Sharing the schedule with other people

A schedule can be shared with other people. This is useful if you want other people to be able to manage the schedule, or be able to manually wakeup machines associated with that schedule. It is also useful if you wish to transfer a schedule to another person.

  1. Type the username or email address of the person with whom you wish to share the schedule in the "add Oxford email or username" box. Please note that this person must have logged on to eem before.
  2. Click "Save" at the bottom or top of the page

4.8. Disassociating yourself from a schedule

If a schedule is shared between one or more people, then any of those people can disassociate themselves with a schedule. Please note that it is not possible to remove some else from a schedule, only yourself

  1. Tick the box next to "Disassociate yourself from this shared schedule"
  2. Click "Save" at the bottom or top of the page

4.9. Finding a schedule

The processes listed above assume that you are already looking at a schedule. To find an existing schedule to view or edit:

  1. At the home page click "Manage schedules and groups"
  2. All schedules that you share will be displayed and you will be able to manage wakups, exceptions and sharing

4.10. Finding a machine

Sometimes you will need to update details on an individual machine. To find the machine, list your schedules and then click the machine friendly name in the list of "Machines in this schedule"

4.11. Transferring a machine from one schedule to another

At times you will wish to transfer a machine from one schedule to another. To do this:

  1. Find the machine (see above)
  2. At the bottom of the page you can chose which with which of the schedules that you share this machine should be associated with; click the desired schedule
  3. Click "Save" at the bottom or top of the page

4.12. Removing an empty schedule

If a schedule has no machines associated with it then you can delete it. To do this:

  1. At the home page click "Manage schedules and groups"
  2. Any schedules that have no machines associated with them will appear with "This schedule is empty. Do you wish to delete it?" at the top
  3. Tick the box next to this message on one or more schedules
  4. Click "Save" at the bottom or top of the page

4.13. Creating a manual group

Schedules are normally created at machine registration, but it is also possible to create one manually at any time. EEM calls these "manual groups" any they do not offer the same functionality as schedules. For example, it is not possible to add wakeups to them. The primary purpose of a manual group is to provide a means of conveniently turning on a number of machines - e.g. in a computer lab.

  1. At the home page click "Manage schedules and groups"
  2. At the bottom of the page click "Create a new manual group"
  3. Type a name for the group in the box (it will have "MaGroup" and the time in it by default)
  4. Choose the machines you wish to include in the group by ticking them. The list will include all machines associated with schedules that you share. Please note that these machines will remain in their schedules.
  5. Click "Create" at the bottom or top of the page

4.14. Editing a manual group

A manual group can be found in the same way as a schedule. Some functionality available for schedules is not available for groups. One function that is available for manual groups only is that to add or remove machines.

  1. Click "add or remove" next to the list of machines:
    • Choose the machines you wish to include in the group by ticking or unticking them. The list will include all machines associated with schedules that you share.
  2. Click "Save changes" at the bottom or top of the page

4.15. Manually Waking up the schedule/group

All machines associated with a schedule or group can be woken at any time.

  1. At the home page click "Manage schedules and groups"
  2. Click a machine in the schedule or group you wish to wake
  3. In the schedule section click "Turn on group now"

4.16. Manually waking a single machine

  1. At the home page click "Turn a machine on"
  2. Click the machine which you wish to wake

4.17. Renaming a schedule or group

A schedule or group can be renamed at any time.

  1. At the home page click "Manage schedules and groups"
  2. Update the name of a schedule or group where it appears above the wakeups (or list of machines for manual groups)
  3. Click "Save" at the bottom or top of the page

4.18. Renaming a machine

The friendly name of a machine can be viewed at any time. Find the machine (see above) and update the machine name where it appears above the machine properties.

4.19. Viewing diagnostic logs

Diagnostic logs can be viewed by clicking "See diagnostic logs" at the bottom of the page displaying schedules and groups. This will provide information on when wakeup requests were sent for the schedules and groups.

4.20. Viewing public power usage graphs

Power usage graphs for units can be viewed using the "View usage" link on the home page.

5. Help

Further help is available from the help centre