NAME

lcfg-sysinfo - System Information

VERSION

This documentation refers to lcfg-sysinfo version 1.0.3

DESCRIPTION

This is an LCFG virtual component which is used to store per-host system information. It is designed to contain generic information which is not associated with any specific aspect or service (e.g. apache) on a machine.

This documentation only describes the resources available. See the "SEE ALSO" section below for details on how to query the information.

RESOURCES

The sysinfo component has a set of resources which represent aspects of a machine covering the associated people, the operating system, and the paths to the various standard LCFG locations.

The list of resources has evolved over many years of usage within the Edinburgh University School of Informatics and as such may not include what you need, if there is something for which you would like support added then get in touch with us.

node

This is the hostname for the machine. The default value is taken from the value of the profile.node resource.

domain

This is the domain for the machine. The default value is taken from the value of the profile.domain resource.

manager

This is a string representing the manager (i.e. sysadmin) for the machine. There is no default value but this string can be set via the _ADMIN macro in an LCFG profile.

allocated

This is a string representing the user to which the machine has been allocated. There is no default value.

owner

This is a string representing the owner for the machine. This may be the same as the allocated field but often a machine is owned by a particular organisation and allocated to an individual within that organisation. There is no default value but this string can be set via the _ORG macro in an LCFG profile.

sno

This is a string which holds the serial number for the machine. There is no default value.

model

This is a string which holds the model type for the machine. There is no default value but if you also use the standard LCFG hardware headers (e.g. lcfg/hw/dell_optiplex_755.h) it will be set automatically.

location

This is a string which holds information on the location of the machine. There is no default value but this string can be set via the _LOCATION macro in an LCFG profile.

comment

This is a string which can hold any comments you want to associate with the machine. There is no default value.

release_version

This string holds information on the release and version of the LCFG headers currently being used. The default value of the release part is taken from the value of the profile.release resource and the version part is taken from the LCFG_RELEASE_VERSION macro, the two parts are separated with a forward-slash.

os_id

This is a string which holds a short identification name (e.g. "sl5") for the particular distribution of the operating system being used. There is no default value but this string can be set via the OS_ID macro, if you use the standard LCFG operating-system headers (e.g. lcfg/os/sl5.h) it will be set automatically.

os_name

This is a string which holds the name (e.g. "linux") for the operating system being used. There is no default value but this string can be set via the OS_NAME macro, if you use the standard LCFG operating-system headers (e.g. lcfg/os/sl5.h) it will be set automatically.

os_version

This is a string which holds a the version (e.g. "scientific") of the operating system being used. There is no default value but this string can be set via the OS_VERSION macro, if you use the standard LCFG operating-system headers (e.g. lcfg/os/sl5.h) it will be set automatically.

os_release

This is a string which holds the version number (e.g. "5") for the particular distribution of the operating system being used. There is no default value but this string can be set via the OS_RELEASE macro, if you use the standard LCFG operating-system headers (e.g. lcfg/os/sl5.h) it will be set automatically.

arch

This is a string which holds the architecture (e.g. i386) for the operating system being used. There is no default value but this string can be set via the ARCH_NAME macro, if you use the standard LCFG operating-system headers (e.g. lcfg/os/sl5.h) it will be set automatically.

basearch

In most cases this will be identical to the value stored in the arch resource. Some distributions however, e.g. Fedora, differentiate between the base architecture (i386) and the architecture for which the packages are compiled by default (i686). In that case the arch will be i686 and the basearch will be i386.

display

This resource holds the list of sysinfo resources which should be displayed on the LCFG server status web pages for this particular host. The order within the list controls the order in which the resources appear on the page. Aliases can be given to improve the presentation of the short resource names. An alias should be put in front of the resource name, separated with an equals sign (=). Spaces can be created using the tilde character (~). For example, Serial~No=sno would present the value of the serial number resource with the title "Serial No". The default value for this resource is model location Serial~No=sno allocated manager owner OS=os_id Architecture=arch Release~Version=release_version

criticality

This is a very basic indicator of the relative importance of a machine. It can be set to any one of low, medium or high, the default is low.

paths

This is an LCFG tag list with each key representing a standard LCFG path. By default the following paths are defined: lcfglib, lcfgdata, lcfgbin, lcfgsbin, lcfgcomp, lcfgvar, lcfgstatus, lcfglog, lcfglock, lcfgrotated, lcfgtmp, lcfgconf, lcfgpod, lcfgom

path_tag

This resource contains the value for the path associated with a particular key. For example, sysinfo.path_lcfglib is /usr/lib/lcfg on a standard LCFG linux machine.

SEE ALSO

There is a a Perl interface for querying the LCFG system information, see LCFG::SysInfo for details. For Perl-based LCFG components it can also be queried via the GetSysInfo helper method in LCFG::Component. For shell-bashed LCFG components it can be queried via the GetSysInfo and GetSysPath functions in lcfg-ngeneric(8).

PLATFORMS

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

Fedora12, ScientificLinux5

AUTHOR

Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

Copyright (C) 2008 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.