Index Index for
Section 8
Index Alphabetical
listing for W
Bottom of page Bottom of
page		 

wol(8)


NAME

  wol - Send network packet over subnet to turn on target system power


SYNOPSIS

  /usr/sbin/wol [nw_interface] hw_address


OPTIONS

  nw_interface
      Specifies the network interface to use in making the connection to the
      target system, for example: tu1. This argument is optional.


OPERANDS

  hw_address
      Specifies the hardware network address of the target system, for
      example: 1A-2B-3C-4D-5E-6F . This argument is mandatory.


DESCRIPTION

  The wol utility (wake-on-LAN) generates and transmits a network packet to
  power on a remote system on the same subnet. Before you can use the wol
  utility, you must enable the remote system management wake-on-LAN feature
  on the target system.

  You must specify the target system's hardware address. You may optionally
  specify the network interface to use in making the connection to the target
  system. If no network interface is specified, the wol utility locates the
  first configured network interface and prompts you for confirmation.

  To enable the wake-on-LAN feature, set the target system's wol_enable
  console variable to on and reset the system so that the network controller
  can read the new state. Use one of the following methods to enable this
  feature on the target system:

    ·  From the target system's console prompt. enter the following commands:
	    >>> set wol_enable on
	    >>> init

    ·  From the target system's UNIX root prompt, enter the following
       commands:
	    % consvar -s wol_enable on
	    set wol_enable = on
	    % consvar -a
	    Console environment variables saved
	    % reboot

  Use one of the following methods to disable the wake-on-LAN feature:

    ·  From the target system's console prompt. enter the following commands:
	    >>> set wol_enable off
	    >>> init

    ·  From the target system's UNIX root prompt, enter the following
       commands:
	    % consvar -s wol_enable off
	    set wol_enable = off
	    % consvar -a
	    Console environment variables saved
	    % reboot

				     Note

       You must reset the target system for the new setting to take effect.


RESTRICTIONS

  You must be logged in as root or have superuser privileges to use the wol
  utility.

  The target system must be on the same subnet as the system where you invoke
  the wol utility.

  You cannot turn off the power on a target system with the wol utility.

  The wake-on-LAN feature is only available on specific platforms. On
  platforms that support this feature, additional restrictions may apply. For
  example, the wake-on-LAN feature may be supported on specific network
  interface ports only. See your hardware documentation for additional
  information.


EXIT STATUS

  0 (Zero)
      Success.

  >0  An error occurred.


ERRORS

    ·  Error detecting default interface

       Explanation:

       The wol utility cannot automatically detect a default network
       interface.

       User Action:

	 -- Verify that a configured network interface exists on your system.

	 -- Manually specify a configured network interface on the wol
	    command line.

    ·  Patterns must be specified as hex digits The Magic Packet address must
       be specified as 00-11-22-33-44-55

       Explanation:

       The hardware network address entered was in the wrong format. This
       argument must be in the following format: xx-xx-xx-xx-xx-xx, where x
       is a hexadecimal character (0 through 9 and A through F, inclusive).

       User Action:

       Specify the hardware network address correctly.

    ·  wand: socket: Address family not supported by protocol family

       Explanation:

       The system where you entered the wol command is not on the same subnet
       as the target system.

       User Action:

       Enter the wol command on a system that is on the same subnet as the
       target system.


EXAMPLES

   1.  The following example shows a simple use of the wol utility, where the
       host system detects the first configured network interface and prompts
       for confirmation:
	    # /usr/sbin/wol 00-02-56-00-03-29
	    No sending device specified, using tu0, continue? (y/n) y

   2.  The following example shows the same use of the wol utility, where the
       user declines confirmation of the selected network interface:
	    # /usr/sbin/wol 00-02-56-00-03-29
	    No sending device specified, using tu0, continue? (y/n) n
	    Aborting...

   3.  The following example explicitly specifies a network interface:

	    # /usr/sbin/wol tu1 00-02-56-00-03-29


ENVIRONMENT VARIABLES

  wol_enable
      Enables or disables the wake-on-LAN feature on the target system. Valid
      values are on and off.

				       Note

	 This is a system console variable, not a UNIX environment variable.
	 The DESCRIPTION section tells you how to enable the wake-on-LAN
	 feature on the target system. You must enable this feature before
	 you use the wol utility.


FILES

  /usr/sbin/wol
      Wake-on-LAN utility.


SEE ALSO

  Commands: consvar(8), halt(8), reboot(8), shutdown(8)

  New Hardware Delivery Release Notes and Installation Instructions

  System Administration

Index Index for
Section 8
Index Alphabetical
listing for W
Top of page Top of
page