unixdev.net


Switch to SpeakEasy.net DSL

The Modular Manual Browser

Home Page
Manual: (OSF1-V5.1-alpha)
Page:
Section:
Apropos / Subsearch:
optional field



hwmgr_get(8)							 hwmgr_get(8)



NAME

  hwmgr_get, hwmgr_set - Commands that display and set component attributes
  and identify component categories.

SYNOPSIS

  /sbin/hwmgr get category

  /sbin/hwmgr get attribute [saved | default | current]	[-a attribute...] [-a
  attribute=value] [-a attribute!=value] [-id hardware-component-id]
  [-category hardware-category]	[-member cluster-member-name] [-cluster]

  /sbin/hwmgr set attribute [saved | current] -a attribute=value [-a
  attribute=value]... [-id hardware-component-id] [-member cluster-member-
  name]	[-cluster]

OPTIONS

  get category
      Returns a	list of	all hardware component categories available on the
      system, such as platform,	scsi_bus, and disk.

  get attribute
      Returns attribute	values for a component . You can specify the com-
      ponent attributes	to return, according to	their type and one or more
      optional matching	parameters. An attribute can have up to	three values:

      saved
	  This is the value of an attribute that is configured and stored in
	  the database using the set saved command option. When	you set	the
	  saved	value of an attribute, it is saved across boots	and is used
	  on subsequent	reboots.

      default
	  This is the default value of an unmodified attribute.	When you add
	  a new	component and boot the system, the attributes of the new com-
	  ponent are at	their default values.

      current
	  This is the value of the attribute that the driver is	currently
	  using	in its operation of the	component.  If you set an attribute
	  by using the set current option, the saved value is unchanged. When
	  you shut down	and reboot the system, the value of the	attribute
	  reverts to the value saved in	the database. If you want the value
	  you are using	to persist across boots, you must use the set saved
	  command option. The get command option displays the current values
	  by default.

      Not all attributes have a	current, saved,	and default value. Most	com-
      ponent attributes	have read-only values and you cannot set them. Typi-
      cally, you are able to set only a	few attributes for a given device. In
      most cases, if an	attribute is settable it also has a saved value. You
      can set this saved value and it will be read on the next reboot.

      Settable attributes are marked (settable)	when you use the get attri-
      bute option.  The	following truncated display shows an example:


	   # /sbin/hwmgr get attribute
	   path_fail_limit = 5
	   device_starvation_time = 25 (settable)
	   cluster_disables = 0

      For each attribute value (saved, default,	or current) you	can specify
      the following optional parameters:

      -a attribute...
	  Displays values of an	individual attribute, such as
	  path_fail_limit, which is a SCSI disk	attribute defining the limit
	  for path failures.

      -a attribute=value...
	  Displays attributes that match the specified name and	the specified
	  value. For example, to search	for components that support power
	  management, use the following	command:


	       # /sbin/hwmgr get attribute -a power_mgmt_capable=1

      -a attribute!=value...
	  Displays attributes that do not match	the specified name but do not
	  match	the specified value. For example:


	       # /sbin/hwmgr get attribute -a power_mgmt_capable!=1

      -id hardware-component-id
	  Displays the attribute values	for the	specified hardware device
	  identifier (HWID). For example, the following	command	returns	all
	  the current attribute	values for hardware component 18:


	       # /sbin/hwmgr get attribute current -id 18

      -category	hardware-category
	  Specifies a hardware category, such as bus or	ide_adapter on which
	  to perform the operation.  You can display the available categories
	  by using the get category command option.

      -member cluster-member-name
	  Specifies the	host name of a cluster member on which to perform the
	  operation.

      -cluster
	  Specifies that the operation be performed cluster-wide.  If this
	  option is not	specified, data	for the	local host is returned.

  set attribute
      Sets either the saved or current value for the specified attribute(s).
      Refer to the get flag for	more information. You cannot set default
      attribute	values.

      You can specify the following parameters:

      -a attribute=value...
	  You must supply at least one attribute and a value. Specify addi-
	  tional attributes to set as required,	subject	to limitations on the
	  command input	buffer.

      -id hardware-component-id
	  Specifies a hardware component identifier (HWID) on which to per-
	  form the operation.

      -member cluster-member-name
	  Specifies the	host name of a cluster member on which to perform the
	  operation.

      -cluster
	  Specifies that the operation be performed cluster-wide.  If the
	  system is part of a cluster and this option is not specified,	the
	  operation is performed only on the local host.

	  The values of	the attributes of a particular hardware	component
	  might	not be the same	for each member	of the cluster.	 One hardware
	  component may	have different attributes, or different	values for
	  the same attributes, for each	cluster	member.


					Caution

	     You should	specify	a hardware identifier when setting an attri-
	     bute.  Failure to do so will set the attribute value on all
	     hardware components that support the specified attribute.



DESCRIPTION

  The commands described in this reference page	are a subset of	the command
  options available from the hwmgr utility. Refer to hwmgr(8) for more infor-
  mation.

  Use these commands to:

    +  Obtain (get) or configure (set) the values of various component attri-
       butes. A	component attribute is a physical or logical characteristic
       of a component which you	might need to obtain or	set to manage the
       device. For example, a hard disk	might support a	set of attributes
       that define its power management	capabilities. To better	manage power
       use on your system, review the current value of these attributes	and
       possibly	set them to different values.

    +  Obtain a	list of	all hardware component category	names that are avail-
       able on the system. You might need this information as input to other
       hwmgr commands .

  The get and set command options for the hwmgr	command	are used in conjunc-
  tion with the	command	options	described in the following pages:

    +  hwmgr_view(8) - Describes commands that enable you to display informa-
       tion about the status of	the system and its hardware components.

    +  hwmgr_show(8) - Describes commands that enable you to display informa-
       tion from the hardware component	databases.

    +  hwmgr_ops(8) -  Describes commands that enable you to perform adminis-
       trative tasks on	hardware components, such as scanning buses, locating
       components, powering off	components, and	deleting components.

  See the System Administration	manual for more	information on device names
  and device special files and a definitive list of the	supported device
  names.  You can run some hwmgr commands directly from	the SysMan Menu. You
  can also monitor properties and attributes by	using the SysMan Station GUI.


RESTRICTIONS

  When working on a cluster, if	you do not specify a member name the opera-
  tion defaults	to the local member. Some command options might	require	that
  you specify a	member name, but in general it is an option.

ERRORS

  The command returns an int with an errorno from <&lt;errno.h>&gt;.

EXAMPLES

  These	examples have been reformatted for ease	of reference.  The actual
  formatted output from	commands is slightly different.

   1.  The following command shows partial output of all attributes for	all
       components on the system:


	    # /sbin/hwmgr get attribute
	    1:
	      name = AlphaServer 800 5/500
	      category = platform
	      memory_size_MB = 256
	      registration_time	= Mon May 14 11:11:04 2001
	      user_name	= (null) (settable)
	      location = (null)	(settable)
	      software_module =	(null)
	      state = available
	      state_previous = unknown
	      state_change_time	= none
	      event_count = 0
	      last_event_time =	none
	      access_state = online
	      access_state_change_time = none
	      capabilities = 0
	      indicted = 0
	      indicted_probability = (null)
	      indicted_urgency = (null)
	      disabled = 0
	    <&lt;long display output truncated>&gt;

       You can display information for specific	devices	by specifying a
       hardware	identifier (HWID), as shown in the following example:


	    # /sbin/hwmgr get attribute	-id 4
	    4:
	      name = pci0
	      category = bus

       You can display information about attribute values by specifying
       attributes, as follows:


	    # /sbin/hwmgr get attribute	-a name	-id 4
	    4:
	      name = pci0

   2.  The following command displays the hardware category names found	on
       the local system:


	    # /sbin/hwmgr get cat

	    Hardware Categories
	    -------------------
	    category = undefined
	    category = platform
	    category = cpu
	    category = pseudo
	    category = bus
	    category = connection
	    category = unconfigured_hardware
	    category = scsi_adapter
	    category = scsi_bus
	    category = graphics_controller
	    category = parallel_port
	    category = keyboard
	    category = pointer
	    category = fdi_controller
	    category = disk
	    category = network


   3.  The following example shows how you set attributes that are flagged as
       (settable) in the output	from the /sbin/hwmgr get attribute command:


	    # /sbin/hwmgr get attr saved -id 18	-a device_starvation_time
	    18:
	      saved device_starvation_time = 25	(settable)
	    # /sbin/hwmgr set attr saved -id 18	-a device_starvation_time=30
	    18:
	      saved device_starvation_time = 30

       The first command displays the saved attribute named
       device_starvation_time for device id 18,	a hard disk.  The second com-
       mand increases the saved	value from 25 to 30.

   4.  Having set one of a a component's settable attributes, as shown in
       Example 3, you can use the following command to display its default or
       current value as	follows:
	    # /sbin/hwmgr get attr default -id 18 -a device_starvation_time
	    18:
	      default device_starvation_time = 25
	    # /sbin/hwmgr set attr current -id 18 -a device_starvation_time=30
	    18:
	      device_starvation_time = 30 (settable)



FILES

  See hwmgr(8).

SEE ALSO

  Commands: dsfmgr(8), hwmgr_view(8), hwmgr_show(8), hwmgr_ops(8), sysman(8),
  and sysman_station(8)

  Files: olar_config(4)

  Misc:	olar_intro(5)

  System Administration, Managing Online Addition and Removal