sd.4 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

sd(4) 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 ﬁlesets). In addition, they deﬁne 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 ﬁle formats used to store their deﬁnitions.

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

man5sd

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 ﬁlesystems) 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 (for example, tape or CD-ROM) which contains pro-

ducts or bundles available for installation. Depot corresponds to the distribution class

deﬁned 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 pri-

mary root ﬁlesystem, "/". It also represents the set of software objects installed into an

alternate root directory. Root corresponds to the installed_software class deﬁned in

POSIX.

vendor The vendor who packaged and distributed a product or bundle. It is an optional com-

ponent of a product or a bundle .

category A classiﬁcation for a product or bundle, such as "systems_management," "desktop," or

"patch."

bundle A bundle is a way of encapsulating products, subproducts and ﬁlesets into a single

software object. More than one bundle can contain the same software objects. A bundle

can be thought of as a particular "conﬁguration" 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 ﬁlesets and zero or more subproducts .Aproduct

can also contain zero or more control_ﬁles.

subproduct

A subset or partitioning of a software product. It is an optional component of a product .

and contains one or more ﬁlesets .

fileset A grouping of one or more ﬁles contained in a product or sub-product . It groups a subset

of a product’s ﬁles into a manageable unit. A ﬁleset can also contain zero or more

control_ﬁles.

file The actual ﬁles that make up a ﬁleset that get installed, conﬁgured, and removed.

control_files

The scripts developed by vendors to perform product -orﬁleset -speciﬁc 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 attri-

butes can be deﬁned for an object when creating products or bundles with

swpackage. See swpack-

age(4) for details on this subset.

HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1

Summary of content (26 pages)

PAGE 1
sd(4) 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.
PAGE 2
sd(4) sd(4) 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 swpackage or swcopy. (Refer to swpackage(4) for more information on INDEX and INFO files.) The keyword is a filename character string.
PAGE 3
sd(4) sd(4) Depot Attributes Attribute copyright data_model_revision description dfiles layout_version mod_date Value Type multi_line_string revision_string multi_line_string tag_string revision_string one_line_string mod_time name_max number path_max pfiles tag title uuid contained bundles unsigned_integer unsigned_integer one_line_string unsigned_integer tag_string tag_string one_line_string one_line_string list of bundle objects list of product objects media object vendor objects category objects c
PAGE 4
sd(4) sd(4) 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.
PAGE 5
sd(4) sd(4) 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.
PAGE 6
sd(4) sd(4) 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. A • Attributes marked with a - apply only to the bundle class.
PAGE 7
sd(4) sd(4) Attribute + all_filesets * architecture category_tag - contents control_directory copyright create_date create_time data_model_revision description directory install_date install_source install_type instance_id is_locatable is_patch layout_version * location machine_type mod_date mod_time number os_name os_release os_version + postkernel qualifier + readme * revision share_link size software_spec * tag title * vendor_tag + contained control scripts + contained filesets + contained subproducts
PAGE 8
sd(4) sd(4) 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.
PAGE 9
sd(4) sd(4) 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.
PAGE 10
sd(4) sd(4) Subproduct Attributes Attribute contents description size software_spec tag title Value Type repeatable list of tag_string values multi_line_string unsigned_integer software_specification tag_string one_line_string Size 8K 64 256 Example commands data man commands data man "This subproduct ..." 14638872 Networking.Run,r=1.0 Manager Management Utilities contents A list of the filesets or subproducts that make up the subproduct.
PAGE 11
sd(4) sd(4) Attribute ancestor Size applied_patches Value Type repeatable list of software specs software_spec architecture one_line_string 64 category_tag control_directory corequisites tag_string path_string repeatable list of software_specs one_line_string 64 255 64 unsigned_integer revision_string 64 create_date create_time data_model_ revision description exrequisites install_date install_source instance_id is_kernel is_locatable is_packaged_ in_place is_patch is_reboot is_secure is_spar
PAGE 12
sd(4) sd(4) superseded_by software_spec supersedes software_spec tag title contained control scripts contained files tag_string one_line_string list of control script objects list of file objects 64 256 product.fileset, version product.fileset, fr=revision commands Commands ancestor A list of filesets that will match the current fileset when installed on a target system if the match_target installation option is specified. Also determines the base to which a patch is applied.
PAGE 13
sd(4) sd(4) place. If true, then the fileset’s contents are actually references to the original source files used to construct the fileset. 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. is_reboot Defines whether or not the fileset requires a reboot after install. is_secure Defines whether or not the fileset is encrypted on a CD-ROM media, requiring a codeword to install.
PAGE 14
sd(4) sd(4) is being installed. Used for filesets that define a new OS. prerequisites A list of dependencies on software that must be installed before this software can be installed. revision The revision (release number, version number) of the fileset. size The size of the fileset in bytes. state The current state of the fileset (resulting from the most recent operation performed on it). software_spec The full software specification for the fileset. Used to identify a unique fileset.
PAGE 15
sd(4) sd(4) File Attributes Attribute cksum compressed_cksum compressed_size compression_state compression_type gid group is_volatile link_source mode mtime owner path revision size source type uid Value Type unsigned_integer unsigned_integer unsigned_integer compression_enumeration tag_string unsigned_integer tag_string boolean path_string unsigned integer unsigned_integer tag_string path_string revision_string unsigned_integer path_string file_type_enumeration unsigned_integer Size 64 64 8 1024 64 2
PAGE 16
sd(4) sd(4) source The full path to the source file for files which have been "packaged in place"; see swpackage (1M). type The type of file. uid The UID of the file’s owner. VALUE TYPES The value for each attribute must be of a specific type.
PAGE 17
sd(4) sd(4) result_enumeration Maximum length: none One of the following values: none error warning success revision_string Maximum length: 64 bytes Examples: 2.0, B.11.11 Revision strings contain zero or more dot-separated one_line_strings (above). software_specification Maximum length: none Examples: SD.agent or SD,r=2.0,a=HP-UX_B.11.11_32/64 Software specifications specify software in dependencies, ancestors and other attributes, as well as command line selections.
PAGE 18
sd(4) sd(4) SOFTWARE SPECIFICATION SYNTAX The SD commands and attributes support the following syntax for each software_specification: [,r revision ][,a arch ][,v vendor ] [,c category ][,q=qualifier][,l=location ] [,fr revision ][,fa arch ] • You can specify selections with the following shell wildcard and pattern-matching notations: [ ], *, ? For example, *man selects all bundles and products with tags that end with "man". • Bundles and subproducts are recursive.
PAGE 19
sd(4) sd(4) HOST OBJECT FORMAT The file /var/adm/sw/host_object defines the software depots on the local host which have been registered with the swagentd daemon running on the host. The file has this format: host data_model_revision distribution path directory 2.40 Defines a contained (registered) depot distribution path directory ...
PAGE 20
sd(4) sd(4) tag [.instance_id ] The tag component is the product or fileset tag attribute. If more than one product with the same tag exists in the software depot, the instance_id component is necessary. This component is the product or fileset instance_id attribute. On a short-filename filesystem, the tag component is truncated to the first 9 characters (if necessary). All products with the same truncated tag will also have a unique storage directory based on the instance_id component.
PAGE 21
sd(4) sd(4) INDEX FORMAT An INDEX file describes all of the attributes (except for contained scripts and contained files) of a fileset, product, depot, or root. In a depot, the fileset, product, and depot INDEX files are concatenated together to form the catalog/INDEX file. In a root, the fileset, product, and root INDEX files are concatenated together to form the var/adm/sw/products/INDEX file. This section describes the keyword syntax used in an INDEX file.
PAGE 22
sd(4) sd(4) Bundle or Product INDEX Format NOTE: • The tag attribute is always required for all objects. • The contents attribute is required for subproducts and bundles. • Keywords marked with a + apply only to product INDEX format. • Keywords marked with a - apply only to bundle INDEX format.
PAGE 23
sd(4) sd(4) subproduct tag contents description size software_spec title tag_value contents_value description_value size_value software_specification_value title_value Fileset INDEX Format NOTE: • The tag attribute is always required. • The media_sequence_number attribute is required for filesets within a multiple tape distribution. • Multiple definitions of ancestor, corequisites, exrequisites and prerequisites are allowed.
PAGE 24
sd(4) sd(4) INFO FORMAT An INFO file describes all of the control scripts and other files contained within a fileset or product. This section describes the keyword syntax used in an INFO file. Control File Format control_file tag interpreter path result tag_value interpreter_value path_value result_value The path, and tag attributes are required.
PAGE 25
sd(4) sd(4) LOCKING These commands use a common locking mechanism for reading and modifying both root directories and software depots. This mechanism allows multiple readers but only one writer on a root or depot. The commands which modify software in an (alternate) root directory are restricted from simultaneous modification using fcntl() locking on the file var/adm/sw/products/swlock relative to the root directory (for example, /var/adm/sw/products/swlock).
PAGE 26
(Notes) A (Notes) sA 26 Hewlett-Packard Company −1− HP-UX 11i Version 3: September 2010