sd(4)

NAME

sd — all objects that Software Distributor (SD) uses, their attributes and storage formats

DESCRIPTION

The SD commands create, install, distribute and manage software objects (bundles, products, subproducts and filesets). In addition, they define and manage other objects in support of the software administration tasks which users perform. This manual page describes the SD software object classes, their attributes, and the file formats used to store their definitions.

For an overview of all SD commands, see the sd(5) manual page by typing: man 5 sd

The objects described here conform to layout_version 1.0 of the IEEE Standard 1387.2: Software Administration (POSIX). The previous SD layout_version 0.8 is also supported. For more details, see swpackage(4) or the layout_version option in sd(5).

OBJECT CLASSES

The SD object classes are:

host: A machine at which software is installed, will be installed, or is being managed. A host contains one or more roots (installed filesystems) and zero or more depots.
depot: A directory location which contains software products or bundles that are available for installation. It is a customizable source of software used for direct installation. It can also represent a distribution medium (e.g. tape or CD-ROM) which contains products or bundles available for installation. Depot corresponds to the distribution class defined in POSIX.
media: Vehicle for software delivery. When a depot is located on one or more media in layout_version=1.0, the unique sequence number identifying each medium is in the media class.
root: A set of installed software objects, usually the operational software installed in the primary root filesystem, "/". It also represents the set of software objects installed into an alternate root directory. Root corresponds to the installed_software class defined in POSIX.
vendor: The vendor who packaged and distributed a product or bundle. It is an optional component of a product or a bundle.
category: A classification for a product or bundle, such as "systems_management," "desktop," or "patch."
bundle: A bundle is a way of encapsulating products, subproducts and filesets into a single software object. More than one bundle can contain the same software objects. A bundle can be thought of as a particular "configuration" of software. It is a convenient way to group software objects together for easy selection. Bundle is NOT a superset of product.
product: A software object which vendors package and distribute, and which users purchase and install. A product contains one or more filesets and zero or more subproducts. A product can also contain zero or more control_files.
subproduct: A subset or partitioning of a software product. It is an optional component of a product. and contains one or more filesets.
fileset: A grouping of one or more files contained in a product or sub-product. It groups a subset of a product's files into a manageable unit. A fileset can also contain zero or more control_files.
file: The actual files that make up a fileset that get installed, configured, and removed.
control_files: The scripts developed by vendors to perform product- or fileset-specific operations during various software management tasks. Often called control_scripts.

OBJECT ATTRIBUTES

The following tables summarize the valid attributes for each software object class. A subset of these attributes can be defined for an object when creating products or bundles with swpackage. See swpackage(4) for details on this subset.

The attribute value types are defined in the next section, "VALUE TYPES".

Vendor-Defined Attributes

You can create your own software attributes when packaging software. Keywords in a product specification file that are not recognized by SD are preserved, along with their associated values, by being transferred to the resulting INDEX or INFO files created by swpackageor swcopy. (Refer to swpackage(4) for more information on INDEX and INFO files.)

The keyword is a filename character string. The value associated with a keyword is processed as an attribute_value. It can be continued across multiple input lines or can reference a file containing the value for the keyword.

Vendor-defined attributes are noted during packaging or when modified with swmodify. These attributes can be listed with swlist.

Host Attributes

Attribute	Value Type	Size	Example
`machine_type`	uname_string	32	ia64 hp server g4000
`name`	one_line_string	64	dist.hp.com
`os_name`	uname_string	32	HP-UX
`os_release`	uname_string	32	B.11.11
`os_version`	uname_string	32	C
`contained depots`	list of depot
	objects
`contained roots`	list of root
	directories

machine_type: The host's machine and architecture designation. (See output of the model command.)
name: The official name of the network host.
os_name: The host's operating system name. (uname -s).
os_release: The host's operating system release. (uname -r).
os_version: The host's operating system version. (uname -v).
contained depots: The depots registered at the host.
contained roots: The root filesystems registered on this system.

Depot Attributes

Attribute	Value Type	Size	Example
`copyright`	multi_line_string	8K	"This depot ..."
`data_model_revision`	revision_string	64	2.40
`description`	multi_line_string	8K	"This depot ..."
`dfiles`	tag_string	64	dfiles
`layout_version`	revision_string	64	1.0
`mod_date`	one_line_string	64	Tue Jun 22 12:52:09
			2001
`mod_time`	unsigned_integer		740774837
`name_max`	unsigned_integer		255
`number`	one_line_string	64	B2358-13601
`path_max`	unsigned_integer		1023
`pfiles`	tag_string	64	pfiles
`tag`	tag_string	64	APPLICATIONS_CD
`title`	one_line_string	256	Applications Software
`uuid`	one_line_string	64	25CA7C86-6F0C-9353
`contained bundles`	list of bundle
	objects
`contained products`	list of product
	objects
`contained media`	media object
`contained vendors`	vendor objects
`contained categories`	category objects

copyright: The copyright information for the depot or tape.
data_model_revision: The HP specific format revision used to store the depot definition.
description: The multi-paragraph description of the distribution depot/tape.
dfiles: The name of a directory that contains any attributes that must be stored as files.
layout_version: The version of the IEEE Standard 1387.2 (1.0 or 0.8) to which the HP-specific data_model_revision conforms.
mod_date: The string format of the mod_time.
mod_time: The time of the last operation performed on the depot.
name_max: The maximum length of file basenames in the depot.
number: The part or manufacturing number of the depot/tape.
path_max: The maximum length of file pathnames in the depot.
pfiles: The name of a directory that contains any product control_files or any product attributes that must be stored as files.
tag: The identifier (short name) for the distribution depot/tape.
title: The full name (one-line description) of the distribution depot/tape.
uuid: The depot's Universal Unique Identifier (UUID).
contained bundles: The bundles available from the depot.
contained products: The products available from the depot.
contained media: The object defining the sequence number used to identify each medium.
contained vendors: The objects defining a vendor object that is associated with subsequent bundle and product objects that define a vendor_tag attribute.
contained categories: The objects defining a category object that is associated with subsequent software objects and define a category_tag attribute.

Media Attributes

Generated by swpackage.

Attribute	Value Type	Size	Example
`sequence_number`	one_line_string	64	1

sequence_number: For a multiple tape distribution, this attribute defines the unique sequence_number of each medium.

Root Attributes

Attribute	Value Type	Size	Example
`data_model_revision`	revision_string	64	2.40
`description`	multi-line_string	2048	"This root is ..."
`dfiles`	tag_string	64	dfiles
`layout_version`	revision_string	64	1.0
`mod_date`	one_line_string	64	Mon Jun 14 13:01:19
			2001
`mod_time`	unsigned_integer		740774837
`path`	one_line_string	256	/xx/xx/xx
`pfiles`	tag_string	64	pfiles
`root_type`	one_line_string	256	shared
`contained bundles`	list of bundle
	objects
`contained products`	list of product
	objects
`contained vendors`	vendor objects
`contained categories`	category objects

data_model_revision: The HP specific format revision used to store the root definition.
description: A multi-line description of the root.
layout_version: The version of the IEEE Standard 1387.2 (1.0 or 0.8) to which the HP-specific data_model_revision conforms.
mod_date: The string format of the mod_time.
mod_time: The time of the last operation performed on the root.
path: The path to the root.
root_type: The type of root: shared, private or none.
contained bundles: The bundles installed into the root.
contained products: The products installed into the root.
contained vendor: The object defining a vendor object that is associated with subsequent bundle and product objects that define a vendor_tag attribute.
contained category: The object defining a category object that is associated with subsequent software objects that define a category_tag attribute.

Vendor Attributes

Attribute	Value Type	Size	Example
`description`	multi_line_string	8K	"This vendor ..."
`title`	one_line_string	256	Hewlett-Packard Company
`tag`	tag_string	64	HP
`uuid`	one_line_string	64	1234567-CDEF-0123-4569

description: The multi-paragraph description of the vendor.
tag: The identifier (short name) for the vendor. Used to associate a vendor object with subsequent product or bundle objects having a vendor_tag attribute of the same value.
title: The full name (one-line description) for the vendor.
uuid: The vendor's Universal Unique Identifier (UUID).

When listing the attributes of a vendor associated with the specified product or bundle using swlist, the option -a vendor lists all of the vendor attributes. The option -a vendor.attribute can be used to list specific vendor attributes (e.g. -a vendor.title).

Note that the vendor specification is not the same as vendor-defined attributes described in the "Vendor-Defined Attributes" section. Vendor specification describes who is providing the software. Vendor-defined attributes associate extra miscellaneous data with the software.

Category Attributes

Attribute	Value Type	Size	Example
`description`	multi_line_string	8K	normal patches
`revision`	revision_string	64	0.0
`tag`	tag_string	64	normal_patch
`title`	one_line_string	256	patches for normal use

description: A more detailed description of the category.
tag: A short name identifying the category. Each category must have a unique tag. This attribute has no default value. The category tag patch is reserved. When is_patch is set to true for a software object, a built-in category_tag attribute of value patch is automatically included.
title: A longer name of the category used for presentation purposes.
revision: Determines which category object definition to maintain in a depot when a definition being installed or copied does not match a definition already in the depot with the same category_tag. The category definition with the higher revision is maintained.

Bundle and Product Attributes

Attributes marked with a + apply only to the product class.
Attributes marked with a - apply only to the bundle class.
Attributes marked with a * determine the uniqueness of a product or bundle object instance. Their values may also be of the type version_component when used in a version component of a software specification.

Attribute	Value Type	Size	Example
`+ all_filesets`	one-line list of		commands agent
	tag_string values		data man
`* architecture`	one_line_string*	64	HP-UX_B.11.11_32/64
`category_tag`	tag_string	64	normal
`- contents`	repeatable list of	8K	foo.bar,r=1.0,a=,v=HP
	software_specs		x.y,r=2.0,a=,v=
`control_directory`	path_string	255	SD
`copyright`	multi_line_string	8K	"This product ..."
`create_date`	one_line_string	64	Mon Jun 14 13:01:19
`create_time`	unsigned_integer		740084479
`data_model_revision`	revision_string	64	2.40
`description`	multi_line_string	8K	"This product ..."
`directory`	path_string	1024
`install_date`	one_line_string	16	200102241212.34
`install_source`	one_line_string	1024	zook.com:/depot
`install_type`	one_line_string	16	physical
`instance_id`	tag_string	64	1
`is_locatable`	boolean	8	true
`is_patch`	boolean	8	true
`layout_version`	revision_string	64	1.0
`* location`	path_string	1024	/
`machine_type`	uname_string	64	ia64*
`mod_date`	one_line_string	64	Mon Jun 14 13:01:19
			2001
`mod_time`	unsigned_integer		740084479
`number`	one_line_string	64	J2326AA
`os_name`	uname_string	64	HP-UX
`os_release`	uname_string	64	?.11.*
`os_version`	uname_string	64	[A-Z]
`+ postkernel`	path_string	255	/usr/bin/kernel_build
`qualifier`	one_line_string	64	"My product"
`+ readme`	multi_line_string	1024K	< README
`* revision`	revision_string	64	2.0
`share_link`	one_line_string	256	"sbin"
`size`	unsigned_integer		14638872
`software_spec`	software_spec		SD,r=2.0
`* tag`	tag_string	64	SD
`title`	one_line_string	256	Software Distributor
`* vendor_tag`	tag_string	64	HP
`+ contained control`	list of control
`scripts`	script objects
`+ contained`	list of fileset
`filesets`	objects
`+ contained`	list of subproduct
`subproducts`	objects

all_filesets

All the filesets originally packaged into the product.

architecture

The target system(s) on which the product will run.

category_tag

A repeatable tag-based attribute identifying a set of categories of which the software object is a member. This is used as a selection mechanism and can be used independent of patches. The default value is an empty list or patch if the is_patch attribute is set to true. The category tag patch is reserved.

Like vendor_tag, this attribute associates this product or bundle with a category object containing additional information about the category (for example, a one-line title definition and a description of the category).

contents

The list of software_specs for a bundle. (Bundles can contain other bundles.) Fully qualified software specs at the fileset level are recommended when defining packages. (Applies to bundles only).

control_directory

The relative pathname to the product catalog directory within the depot/root catalog that contains control scripts for the product.

copyright

The copyright information for the product.

create_date

The string format of the create_time.

create_time

The time at which the bundle or product was created.

data_model_revision

The format revision used to store the product definition.

directory

The default pathname in which the product's files will be installed.

description

The multi-paragraph description of the product.

install_date

The installation date of the product or bundle.

install_source

The source from which the product was installed.

install_type

The type of installation - "physical" or "NFS_mount".

instance_id

The secondary identifier for products which have the same tag (or truncated tag) value.

is_locatable

Defines whether (or not) the product can be installed into an arbitrary directory.

is_patch

Identifies a software object as a patch. The default value is false. When set to true, a built-in category_tag attribute of value patch is automatically included.

layout_version

The version of the IEEE Standard 1387.2 (1.0 or 0.8) to which the HP-specific data_model_revision conforms.

location

The installed pathname of the product.

machine_type

The machine(s) on which the product will run.

mod_date

The string format of the mod_time.

mod_time

The time of the last operation performed on the product.

number

The part or order number for the product.

os_name

The operating system(s) on which the product will run.

os_release

The operating system release(s) on which the product will run.

os_version

The operating system versions(s) on which the product will run.

postkernel

The path to a script that is run after kernel filesets are installed.

qualifier

A user-specified name that identifies a product or set of product versions. Can be set using swmodify and used in software_specs with other commands.

readme

The most recent information for the product.

revision

The revision (release number, version number) of the product.

share_link

Sharing point(s) for product.

size

The size of the product in bytes.

software_spec

The fully qualified software specification for the bundle or product. This attribute can be used to identify a unique bundle or product.

tag

The identifier (short name) for the product.

title

The full name (one-line description) of the product.

vendor_tag

Associates this product or bundle with a vendor object containing additional attributes describing the vendor. The vendor object must have a matching tag attribute.

contained control scripts

The scripts defined for the product.

contained filesets

The fileset defined for the product.

contained subproducts

The subproducts defined for the product.

Subproduct Attributes

Attribute	Value Type	Size	Example
`contents`	repeatable list of		commands data man
	tag_string values		commands data man
`description`	multi_line_string	8K	"This subproduct ..."
`size`	unsigned_integer		14638872
`software_spec`	software_specification		Networking.Run,r=1.0
`tag`	tag_string	64	Manager
`title`	one_line_string	256	Management Utilities

contents: A list of the filesets or subproducts that make up the subproduct.
description: The multi-paragraph description of the subproduct.
size: The size of the subproduct in bytes.
software_spec: The full software specification for the subproduct. This attribute can be used to identify a unique subproduct.
tag: The identifier (short name) for the subproduct.
title: The full name (one-line description) of the subproduct.

Fileset Attributes

Attribute	Value Type	Size	Example
`ancestor`	repeatable list of		oldprod.fs
	software specs
`applied_patches`	software_spec		product.fileset,
			version
`architecture`	one_line_string	64	HP-UX_B.11.11
			_32/64
`category_tag`	tag_string	64	patch_normal
`control_directory`	path_string	255	SD
`corequisites`	repeatable list of		SD.man
	software_specs
`create_date`	one_line_string	64	Mon Jun 14
			13:01:19 2001
`create_time`	unsigned_integer		740084479
`data_model_`	revision_string	64	2.40
`revision`
`description`	multi_line_string	8K	"This fileset ..."
`exrequisites`	repeatable list of		SD.man
	software_specs
`install_date`	one-line string	16	200102241414.34
`install_source`	one_line_string	1024	zook.com:/depot
`instance_id`	tag_string		1
`is_kernel`	boolean	8	false
`is_locatable`	boolean	8	true
`is_packaged_`	boolean	8	false
`in_place`
`is_patch`	boolean	8	true
`is_reboot`	boolean	8	false
`is_secure`	boolean	8	false
`is_sparse`	boolean	8	false
`location`	path_string	1024	/
`machine_type`	uname_string	64	ia64*
`media_sequence_`	unsigned_integer		1
`number`
`mod_date`	one_line_string	64	Mon Jun 14
			13:01:19 2001
`mod_time`	unsigned_integer		740084479
`os_name`	uname_string	64	HP-UX
`os_release`	uname_string	64	?.11.*
`os_version`	uname_string	64	?
`patch_state`	patch_state_string	16	applied
`pose_as_os_name`	uname string	64	HP-UX:64
`pose_as_os_`	uname string	64	B.11.11
`release`
`prerequisites`	repeatable list of		SD.agent
	software_specs
`revision`	revision_string	64	2.15
`size`	unsigned_integer		14638872
`state`	state_enumeration		corrupt
`software_spec`	software_spec		Networking.Run,
			r=1.0
`superseded_by`	software_spec		product.fileset,
			version
`supersedes`	software_spec		product.fileset,
			fr=revision
`tag`	tag_string	64	commands
`title`	one_line_string	256	Commands
`contained control`	list of control