scc-realm(1)



NAME


	scc-realm - maintenance for realms with SCC-data

RELEASE


	scc-srv	1.7.5

SYNOPSIS


	scc-realm [ -a <syslist> | -d <syslist> ] [ -c | -r ] [-q ] <realm>

DESCRIPTION


	A realm contains the SCC-snapshots of a group of systems and the
	summaries of the snapshots and logbooks. This program creates a 
	realm and adds/deletes systems from a realm.

	When a realm is created, the contents of directory
	/var/opt/scc-srv/data/www/custom are used as default.
	A new realm does not have the file scc-smt-select and scc-rules.conf
	in the sub-directory custom. These files have to created/copied 
	manually. Refer to the manual pages of scc-smt(1) and scc-rules(1) for
	details.

	Realms can be used to restrict the number of systems to be
	searched/viewed. Beside grouping the systems according to your
	departments, you can also create realms for all HP-UX, Solaris
	and RedHat systems. Each system can join several realms.
	
	Realms can be used to restrict access to the SCC-data of systems
	for several groups of administrators. By means of the .htaccess 
	file in a realm, the web-access is controlled.
	It is also possible to setup the directory permissions to
	allow command-line access to the files, based on the groups.

	Suppose that system1 and system2 are the responsibility of the 
	Education department and system3 and system4 for the Sales 
	department.
	After creating two additional realms: Education and Sales, we
	also create three unix groups: scc_all, scc_edu and scc_sale. 
	To control the web- and filesystem-level access, we use the
	following commands:

	   vi /etc/group	# add members to scc_all, scc_edu and scc_sale
	   cd /var/opt/scc-srv/data/www
	   chgrp -R scc_all All
	   chmod g=rx,o=x All
	   chmod g=r All/scc.*
	   scc-realm -c Education
	   chgrp -R scc_edu Education
	   scc-realm -a system1,system2 Education
	   scc-realm -c Sales
	   chgrp -R scc_sale Sales
	   scc-realm -a system3,system4 Sales
	   /opt/scc-srv/bin/scc-update -f

	Edit the .htaccess files in All, Education and Sales. Any 
	administrators that are members of the scc_all, scc_edu and 
	scc_sale groups, have filesystem level access to the SCC-data
	of their systems.
	The same administrators and groups should be specified in the 
	htpasswd and htgroup files to give the same users web-access to 
	SCC-data of their systems. This only works when each system is 
	added to at most one realm beside All.

	To rename a realm, the following commands can be used:

	   cd /var/opt/scc-srv/data/www
	   mv OldRealmDir NewRealmDir
	   cd NewRealmDir
	   /opt/scc-srv/bin/scc-update $(pwd)

	When realms are added or removed, scc-realm attempts to update
	the file /var/opt/scc-srv/data/www/index.html. This file contains
	the list of all the realms. It will only be updated by scc-realm
	when a specific line is present in this file. When updating an 
	existing installation, search this script for the line to be added.
	Look for the string: SCC_REALM. When you do not add this line,
	new realms will not be added automatically.

OPTIONS

	-a <syslist>    Comma separated list of systems to add to <realm>
	-c              Create <realm>, permissions and owner are copied
	                from the directory /var/opt/scc-srv/data/www/custom
	-d <syslist>    Comma separated list of systems to delete from <realm>
	-r              Remove <realm>.
	-q              Do not call scc-update after adding/deleting hosts.

ARGUMENTS


	<realm>         The realm sub-directory in /var/opt/scc-srv/data/www.

DIAGNOSTICS


	This program writes the following messages to stderr:

	Syntax error, use: scc-realm [ -a <syslist> | -d <syslist> ]
		[ -c | -r ] [ -q ] <realm>
	A syntax error has been detected.

	scc-realm: Syntax error, missing argument for option: <option>
	The argument for <option> is missing.

	scc-realm: example directory 'custom' does not exist
	The directory /var/opt/scc-srv/data/www/custom should exist.

	scc-realm: realm directory '<realm>' already exists
	The realm-directory already exists and cannot be created.

	scc-realm: file '<file>' not found
	When adding a system to a realm, the file cannot be found in
	the default realm.

	scc-realm: realm <realm> does not exist, use the -c option
	Systems cannot be added/removed to/from a non-existent realm.

	scc-realm:: attempt to remove non-existent realm '<realm>'
	The realm to be removed was not found.

EXTERNAL INFLUENCES


	This program calls scc-update(1) to update the summaries 
	in <realm>

COPYRIGHT


	scc-realm is free software under the terms of the GNU General Public 
	License. Copyright (C) 2001-2004 Open Challenge B.V.,
	2004-2005 OpenEyeT Professional Services, 2005-2009 QNH.

FILES


	/var/opt/scc-srv/data/www - base-directory for all realms
	  index.html - index with existing realms
	  custom/scc-logo.png - default logo-file
	  custom/scc-realm.conf - default configuration file
	  custom/style.css - default stylesheet
	  All/.htaccess - default access file
	  <realm>/cgi-bin - contains scc-wrapper.cgi for <realm>
	  <realm>/custom - contains the HTML-addons
	        scc-auto-realm.conf - automatic polpulation of realms
		scc-logo.png - logo-file
		scc-realm.conf - configuration for <realm>
		   optional background color can be specified in this file
		   by means of: BG_COLOR=<value>
		style.css - stylesheet for <realm>
	        These files are symbolic links to top-level directory
	        custom.
	  <realm>/.htaccess - controls access to realm

SEE ALSO


	scc-baseline(1), scc-pull(1), scc-realm(1), scc-receive-mail(1),
	scc-rules(1), scc-smt(1), scc-summary(1), scc-syscmp(1), 
	scc-transfer(1), scc-update(1), scc-wrapper.cgi(1), scc.cgi(1),
	scc-srv(5)

VERSION


	$Revision: 1.51 $