swreg(1M)																 swreg(1M)

NAME

       swreg - register or unregister depots and roots

SYNOPSIS

       level session_file] object_file] session_file] target_file] option=value] option_file] [objects_to_(un)register]  target_selections]

   Remarks
	      o  This command supports operations on remote systems.  See below.

	      o  For an overview of all SD commands, see the sd(5) man page by typing on the command line.

DESCRIPTION

       The command controls the visibility of depots and roots to users who are performing software management tasks.  It must be used to register
       depots created by

       By default, the command registers newly created depots.	By default, the command registers newly created alternate roots (the root, is  not
       automatically  registered).   The  command  unregisters	a  depot,  or root, when or if the depot is empty.  The user invokes to explicitly
       (un)register a depot when the automatic behaviors of and do not suffice.  For example:

	      o  Making a CD-ROM or other removable media available as a registered depot.

	      o  Registering a depot created directly by

	      o  Unregistering a depot without removing it with

   Remote Operation
       You can enable SD to manage software on remote systems.	To let the root user from a central SD controller (also called the central manage-
       ment server or manager node) perform operations on a remote target (also called the host or agent):

       1)  Set	up  the root, host, and template Access Control Lists (ACLs) on the remote machines to permit root access from the controller sys-
	   tem.  To do this, run the following command on each remote system:

	   NOTES:

	   o  controller is the name of the central management server.

	   o  If remote system is 11.00, make sure SD patch PHCO_22526 or a superseding patch is installed on remote system before running

	   o  If remote system is older than 11.00 or for some other reason does not have in place, copy script from an 11.11 or higher system	to
	      the remote system.

       2)  and	have  enhanced	GUI  interfaces for remote operations.	Enable the enhanced GUIs by creating the file on the controller.  Use this
	   command:

	   See sd(5), swinstall(1M), swcopy(1M), swjob(1M), swlist(1M), or swremove(1M) for more information on interactive operations.

       NOTE: You can also set up remote access by using directly on the remote machines to grant root or non-root access to users  from  the  con-
       troller system.

   Options
       The command supports the following options:

	      Specify the    level of the object to register or unregister.  Exactly one level must be specified.  The supported levels are:
			     The object to be registered is a depot.
			     The object to be registered is a root.
			     The object to register is a shared root (HP-UX 10.X only).
			     The object to register is a private root (HP-UX 10.X only).

	      Causes	     to unregister the specified objects instead of registering them.

	      Turns on verbose output to stdout.
			     (The logfile is not affected by this option.)  Verbose output is enabled by default, see the option below.

	      Save the current options and operands to
			     session_file.  You can enter a relative or absolute path with the file name.  The default directory for session files
			     is You can recall a session file with the option.

	      Read the list of depot or root objects
			     to register or unregister from object_file instead of (or in addition to) the command line.

	      Execute	     based on the options and operands saved from a previous session, as defined in session_file.  You	can  save  session
			     information to a file with the option.

	      Read the list of target
			     hosts  on	which  to  register  the depot or root objects from target_file instead of (or in addition to) the command
			     line.

	      Set the session
			     option to value and override the default value (or a value in an alternate option_file specified  with  the  option).
			     Multiple options can be specified.

	      Read the session options and behaviors from
			     option_file.

   Operands
       The command supports the following syntax for each object_to_register:

       Each operand specifies an object to be registered or unregistered.

       The command supports the following syntax for each target_selection:

	      [host]

EXTERNAL INFLUENCES

   Default Options
       In addition to the standard options, several SD behaviors and policy options can be changed by editing the default values found in:

	      the system-wide default values.

	      the user-specific default values.

       Values must be specified in the defaults file using this syntax:

       The optional prefix denotes one of the SD commands.  Using the prefix limits the change in the default value to that command.  If you leave
       the prefix off, the change applies to all commands.

       You can also override default values from the command line with the or options:

       The following list describes keywords supported by the command.	If a default value exists, it is listed after the

	      The location for SD logfiles and the default parent directory for the
			installed software catalog.  The default value is for normal SD operations.  When SD operates in nonprivileged mode  (that
			is, when the default option is set to

			o  The default value is forced to

			o  The path element is replaced with the name of the invoking user, which SD reads from the system password file.

			o  If you set the value of this option to path, SD replaces with the invoking user's home directory (from the system pass-
			   word file) and resolves path relative to that directory.  For example, resolves to the directory in	your  home  direc-
			   tory.

			SD's  nonprivileged  mode  is intended only for managing applications that are specially designed and packaged.  This mode
			cannot be used to manage the HP-UX operating system or patches to it.  For a full explanation of nonprivileged SD, see the
			available at the web site.

			See also the option.

	      Defines the location of the depot object to register if no objects
			are specified and the option is specified.

	      Defines the default level of objects to register or unregister.  The
			valid levels are:
			Depots which exist at the specified target hosts.
			All alternate roots.
			All registered shared roots
				       (HP-UX 10.X only).
			All registered private roots
				       (HP-UX 10.X only).

	      Adds numeric identification numbers at the beginning of SD logfile
			messages:
			(default) No identifiers are attached to messages.
			Adds identifiers to ERROR messages only.
			Adds identifiers to ERROR and WARNING messages.
			Adds identifiers to ERROR, WARNING, and NOTE messages.
			Adds identifiers to ERROR, WARNING, NOTE, and certain other
			   informational messages.

	      Specifies the default command log file for the
			command.

	      The	option	controls  the  amount  of  detail written to the log file.  When set to this option adds detailed task information
			(such as options specified, progress statements, and additional summary information) to the log file.  This information is
			in addition to log information controlled by the option.  See the sd(5) man page for additional information by typing

	      Controls the log level for the events logged to the command logfile, the
			target	agent  logfile,  and  the  source  agent logfile.  This information is in addition to the detail controlled by the
			option.  (See also A value of
			provides no information to the logfile.
			enables verbose logging to the logfiles.
			enables very verbose logging to the logfiles.

	      Controls the time in minutes to cache and re-use the results of hostname
			or IP address resolution lookups.  A value of 0 disables the facility to cache and re-use  lookup  results.   The  maximum
			value allowed is 10080 minutes, which is one week.

			A value of:
			disables the lookup caching mechanism.
			is the maximum value allowed.
	      Defines the default objects to register or unregister.  There is no
			supplied default (see above).  If there is more than one object, they must be separated by spaces.
	      Defines the protocol sequence(s) and endpoint(s) on which the daemon
			listens  and  which  the other commands use to contact the daemon.  If the connection fails for one protocol sequence, the
			next is attempted.  SD supports both the tcp and udp protocol sequence on most platforms.
			See the sd(5) man page by typing for details on specifying this option.
	      Relative length of the communications timeout.  This is a value in the
			range from 0 to 9 and is interpreted by the DCE RPC.  Higher values mean longer times; you may need a higher value  for  a
			slow  or  busy network.  Lower values will give faster recognition on attempts to contact hosts that are not up or are not
			running Each value is approximately twice as long as the preceding value.  A value of 5 is about 30 seconds for the proto-
			col sequence.  This option may not have any noticeable impact when using the protocol sequence.
	      This option controls SD's nonprivileged mode.  This option is ignored
			(treated as true) when the invoking user is super-user.
			When  set  to  the  default  value  of	true, SD operations are performed normally, with permissions for operations either
			granted to a local super-user or set by SD ACLs.  (See swacl(1M) for details on ACLs.)
			When set to false and the invoking user is local and is not super-user, nonprivileged mode is invoked:
			o  Permissions for operations are based on the user's file system permissions.
			o  SD ACLs are ignored.
			o  Files created by SD have the uid and gid of the invoking user, and the mode of created files is set	according  to  the
			   invoking user's umask.
			SD's  nonprivileged  mode  is intended only for managing applications that are specially designed and packaged.  This mode
			cannot be used to manage the HP-UX operating system or patches to it.  For a full explanation of nonprivileged SD, see the
			available at the web site.
			See also the option.
	      If no	target_selections are specified, select the default of the local host as the target_selection for the command.
	      Defines the default
			target	hosts  on  which to register or unregister the specified root or depot objects.  There is no supplied default (see
			above).  If there is more than one target selection, they must be separated by spaces.
	      Controls the verbosity of the
			output (stdout).  A value of
			disables output to stdout.  (Error and warning messages
			    are always written to stderr).
			enables verbose messaging to stdout.

   Session File
       Each invocation of the command defines a registration session.  The invocation options, source information, software selections, and target
       hosts  are  saved  before  the installation or copy task actually commences.  This lets you re-execute the command even if the session ends
       before proper completion.

       Each session is saved to the file This file is overwritten by each invocation of

       You can also save session information to a specific file by executing with the session__file option.

       A session file uses the same syntax as the defaults files.  You can specify an absolute path for the session file.  If you do not specify a
       directory, the default location for a session file is

       To re-execute a session file, specify the session file as the argument for the session__file option of

       Note  that  when  you  re-execute  a  session file, the values in the session file take precedence over values in the system defaults file.
       Likewise, any command line options or parameters that you specify when you invoke take precedence over the values in the session file.

   Environment Variables
       SD programs are affected by external environment variables.

       SD programs that execute control scripts set environment variables for use by the control scripts.

       In addition, sets environment variables for use when updating the HP-UX operating system and modifying the HP-UX configuration.

       The environment variables that affect the command are:

	      Determines the language in which messages are displayed.
			   If is not specified or is set to the empty string, a default value of is used.  See the lang(5) man pages by typing for
			   more information.

			   NOTE: The language in which the SD agent and daemon log messages are displayed is set by the system configuration vari-
			   able script, For example, must be set to or to make the agent and daemon log messages display in Japanese.

	      Determines the locale to be used to override any values for locale
			   categories specified by the settings of or any environment variables beginning with

	      Determines the interpretation of sequences of bytes of text data as
			   characters (for example, single versus multibyte characters in values for vendor-defined attributes).

	      Determines the language in which messages should be written.

	      Determines the format of dates
			   (create_date and mod_date) when displayed by Used by all utilities when displaying dates and times in and

	      Determines the time zone for use when displaying dates and times.

   Signals
       The command catches the signals SIGQUIT and SIGINT.  If these signals are received, prints a message, sends a Remote Procedure  Call  (RPC)
       to the daemons to wrap up, and then exits.

RETURN VALUES

       The command returns:

	      The objects_to_register were successfully (un)registered.
	      The register or unregister operation failed on
		  all target_selections.
	      The register or unregister operation failed on
		  some target_selections.

DIAGNOSTICS

       The command writes to stdout, stderr, and to the daemon logfile.

   Standard Output
       The command writes messages for significant events.  These include:

	      o  a begin and end session message,
	      o  selection and execution task messages for each target_selection.

   Standard Error
       The command writes messages for all WARNING and ERROR conditions to stderr.

   Logging
       The command logs summary events at the host where the command was invoked.  It logs events about each (un)register operation to the logfile
       associated with each target_selection.

   swagentd Disabled
       If the daemon has been disabled on the host, it can be enabled by the host's system administrator by setting the entry in to and executing

EXAMPLES

       Create a new depot with then register it with

       Unregister the default depot at several hosts:

       Unregister a specific depot at the local host:

FILES

       Contains the user-specific default values for some or all SD options.

       Contains the master list of current SD options with their default values.

       The directory which contains all of the configurable
	       and non-configurable data for SD.  This directory is also the default location of logfiles.

       Contains the active system-wide default values for some or all SD options.

       The file which stores the list of depots registered at the local host.

AUTHOR

       was developed by the Hewlett-Packard Company.

SEE ALSO

       install-sd(1M), swacl(1M), swagentd(1M), swask(1M), swconfig(1M), swcopy(1M), swinstall(1M), swjob(1M), swlist(1M),  swmodify(1M),  swpack-
       age(1M), swremove(1M), swverify(1M), sd(4), swpackage(4), sd(5).

       available at

       SD customer web site at

																	 swreg(1M)