TME 10 Software Distribution Reference Manual. Version 3.6

Transcription

1 TME 10 Software Distribution Reference Manual Version 3.6 September 1998

2

3 TME 10 Software Distribution Reference Manual (September 1998) Copyright Notice Copyright 1998 by Tivoli Systems, an IBM Company, including this documentation and all software. All rights reserved. May only be used pursuant to a Tivoli Systems Software License Agreement or Addendum for Tivoli Products to IBM Customer or License Agreement. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without prior written permission of Tivoli Systems. The document is not intended for production and is furnished as is without warranty of any kind. All warranties on this document are hereby disclaimed including the warranties of merchantability and fitness for a particular purpose. Note to U.S. Government Users Documentation related to restricted rights Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corporation. Trademarks The following product names are trademarks of Tivoli Systems or IBM Corporation: AIX, IBM, OS/2, RISC System/6000, Tivoli Management Environment, TME 10, TME 10 ADE, TME 10 AEF, TME 10 Distributed Monitoring, TME 10 EIF, TME 10 Enterprise Console, TME 10 Framework, TME 10 Inventory, TME 10 Software Distribution, TME 10 User Administration. Microsoft, Windows, and the Windows 95 logo are trademarks or registered trademarks of Microsoft Corporation. UNIX is a registered trademark in the United States and other countries licensed exclusively through X/Open Company Limited. Other company, product, and service names mentioned in this document may be trademarks or servicemarks of others. Notice References in this publication to Tivoli Systems or IBM products, programs, or services do not imply that they will be available in all countries in which Tivoli Systems or IBM operates. Any reference to these products, programs, or services is not intended to imply that only Tivoli Systems or IBM products, programs, or services can be used. Subject to Tivoli System s or IBM s valid intellectual property or other legally protectable right, any functionally equivalent product, program, or service can be used instead of the referenced product, program, or service. The evaluation and verification of operation in conjunction with other products, except those expressly designated by Tivoli Systems or IBM, are the responsibility of the user. Tivoli Systems or IBM may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to the IBM Director of Licensing, IBM Corporation, 500 Columbus Avenue, Thornwood, New York

4

5 TME 10 Software Distribution Reference Manual Preface... vii Chapter 1 File Package Definitions File Package Definition Format Keyword Options Section Files and Directories Section Nested File Packages Section Exclude Files Section Keywords Chapter 2 Commands Using TME 10 Commands Command Line Syntax Object References Registered Names Object Paths TME 10 Software Distribution Commands NetWare Managed Site Commands Command Syntax waddicon waddpath wclrblk wclrline wcpfpblock wcpyfile wcrtfpblock wdistfp wdistfpblock wdskspc TME 10 Software Distribution Reference Manual i

6 weditini wexprtfp wgetfpattr wgetkey wgetval wimprtfp winsblk winsline winstruct_file wmrgini wmvapobj wmvfpobj wrestart wrmfp wrmfpblock wrplblk wrplline wrunprog wseterr wsetfpattr wsetfpcontents wsetfpopts wsetfpprgs wsettrus wsetval wswdistrim Chapter 3 Policy Default Policy Methods Default Policy Methods for AutoPacks Default Policy Methods for File Package Validation Policy Methods ii Version 3.6

7 Validation Policy Methods for AutoPacks Validation Policy Methods for File Packages Validation Policy Methods and TME 10 Commands Policy Objects Creating a New Policy Object Replacing the Contents of a Policy Method Assigning Policy to a Policy Region Example Setting a Default Policy Method Policy Methods ap_def_autopack_file ap_def_autopack_host ap_val_autopack_host_file ap_val_name ap_val_operation fp_def_excludes fp_def_flist fp_def_nestedlist fp_def_options fp_def_src_host fp_val_delete_src_host fp_val_excludes fp_val_flist fp_val_name fp_val_nestedlist fp_val_operation fp_val_options fp_val_src_host Chapter 4 Configuration Programs Processing Command Line Arguments Processing Input Files Return Codes of Configuration Programs TME 10 Software Distribution Reference Manual iii

8 UNIX Configuration Programs NetWare Configuration Programs PC Configuration Programs PC Environment Space UNIX Example Scripts Rebooting After a File Package Distribution Removing Files from the Destination Directory Running an Installation Script After a Distribution Checking the Architecture Type PC Example Programs Checking Disk Space Preparing a Windows NT Target Before a Distribution Configuring Distributed PC Software Chapter 5 Customizations TME 10 Application Extension Facility Retrieving Dialog Descriptors Changing Existing Dialog Gadgets Exposing File Package Keywords and Excluded Files Creating a Switch Gadget and the Excluded Files List Creating a Choice and Text Gadget Bitmaps and Icons TME 10 Application Development Environment Customizing the File Package Resource The fp_push Method The fp_to_fpblock Method The fp_to_size Method The set_fp_name Method Customizing the AutoPack Resource The calc_size Method The distributep Method The init_by_upload Method iv Version 3.6

9 The init_from_existing Method The removep Method Chapter 6 Troubleshooting How Software Distribution Works Software Distribution Methods Network Communications Distributing to Managed Nodes Distributing from Source Host/TMR Server to Managed Nodes Distributing from Source Host/TMR Server through a Repeater Distributing from a Source Host to Multiple Repeaters Distributing to Endpoints Distributing from Source Host/TMR Server to Endpoints via a Gateway Distributing from Source through Multiple Gateways and Repeaters Distributing to PC Managed Nodes Troubleshooting Tips Examining the File Package Definition Verifying Repeater Parameters and Configurations Checking lost-n-found Checking the Default Directory on a Target System Verifying Setup for Endpoints Verifying Setup for PC Managed Nodes Performing Miscellaneous Debugging Tricks Chapter 7 Object Consistency The fp_name_change Operation The remove_fp Operation The host_name_change Operation The remove_host Operation The wchkdb Command Moving Objects Between Collections TME 10 Software Distribution Reference Manual v

10 vi Version 3.6

11 Preface Preface Tivoli Management Environment 10 (TME 10) Software Distribution application provides a means of managing and distributing software across a multi-platform network that can include UNIX machines, NT and NetWare servers, and PCs running Windows, Windows 95, Windows NT, or OS/2. For distributions that encompass wide area networks (WANs), TME 10 Software Distribution has a built-in, WAN-smart capability that reduces inter-network traffic and ensures an efficient distribution. This manual explains advanced features and concepts necessary for you to effectively use and tailor Software Distribution fully meet your distribution needs. Who Should Read This Manual The target audience for this manual is senior system administrators who intend to improve or customize Software Distribution functionality. You should have knowledge of the UNIX operating system; concepts such as directories, files, and symbolic links; and the PC operating systems running on the machines to which you will distribute software. In addition, you should be familiar with Software Distribution and have use for its advanced features. Prerequisite and Related Documents You must understand the information in the following manuals before attempting to use this guide: The TME 10 Software Distribution User s Guide Provides concepts and procedures for daily file package and AutoPack operations. TME 10 Framework User s Guide, TME 10 Framework Planning and Installation Guide, and TME 10 Framework Reference Manual Provide detailed information and procedures to manage the TME 10 environment from the TME 10 desktop or the command line interface (CLI), including information about configuring, maintaining, and troubleshooting your TME 10 installation. TME 10 Software Distribution Reference Manual vii

12 Preface What This Guide Contains The TME 10 Software Distribution Reference Manual contains the following sections: Chapter 1, File Package Definitions Details how to edit and use the file package definition format and keywords. Chapter 2, Commands Provides the syntax statements, descriptions, and examples of the TME 10 Software Distribution commands. Chapter 3, Policy Describes default and validation policy and how to define policy. Chapter 4, Configuration Programs Describes and provides examples for the Software Distribution before, after, removal, after removal, commit, and on error programs. Chapter 5, Customizations Provides instructions and conceptual information for customizing Software Distribution dialogs and bitmaps. Chapter 6, Troubleshooting Details how Software Distribution works and provides troubleshooting tips for solving problems in your environment. Chapter 7, Object Consistency Describes how Software Distribution maintains database consistency if managed nodes or profiles are deleted or renamed. viii Version 3.6

13 Typeface Conventions The guide uses several typeface conventions for special terms and actions. These conventions have the following meaning: Bold Italics Bold Italics Monospace Platform-Specific Information Preface Commands, keywords, file names, or other information that you must use literally appear in bold typeface. Names of windows, dialogs, and other controls also appear in bold. Variables and values that you must provide appear in italics. New terms appear in bold italic the first time they are used. Code examples appear in monospace font. The following table identifies text used to indicate platform-specific information or procedures. Platform AIX 4.x AS/400 Digital UNIX DG/UX HP-UX NCR Supported Versions Managed Node, Endpoint: IBM RS/6000 series running AIX, Versions 4.1, 4.2, and 4.3 Endpoint: V3R2, V3R7, V4R1, and V4R2 Managed Node, Endpoint: Versions 4.0a and 4.0d. Endpoint: Versions 4.11 and 4.20 on the ix86 platform Managed Node, Endpoint: HP9000/700 and 800 series running HP-UX, Versions 10.01, 10.10, and Managed Node, Endpoint: NCR 3000 series running NCR UNIX SVR4 MP-RAS and TME 10 Software Distribution Reference Manual ix

14 Preface Platform NetWare OS/2 Pyramid Sequent SCO SGI Solaris Solaris Intel SunOS Windows Windows NT Supported Versions PC Agent, Endpoint: IBM-compatible PCs 486 or higher running Novell NetWare, Versions 3.11, 3.12, 4.01, 4.1, and 4.11 TME 10 Desktop for Windows, PC Agent, Endpoint: IBM-compatible PCs 486 or higher running IBM OS/2, Versions 2.0, 2.1,Warp 3.0, and Warp 4.0 with Win-OS/2 Endpoint: Pyramid MIServer-ES, Version 5.4MN Managed Node, Endpoint: Sequent DYNIX/ptx, Releases and Managed Node, Endpoint: SCO UnixWare 7, SCO UnixWare Versions and Managed Node, Endpoint: SGI IRIX, Versions 6.2 and 6.4 Managed Node, Endpoint: Sun SPARC series running Solaris, Versions 2.4, 2.5, 2.5.1, and 2.6 Managed Node, Endpoint: Solaris2-ix86, Versions and 2.6 Managed Node, Endpoint: Sun SPARC series running SunOS, Versions and TME 10 Desktop for Windows, PC Agent, Endpoint: IBM-compatible PCs 486 or higher running Microsoft Windows, Versions 3.1, 3.11, and Windows 95 TME 10 Desktop for Windows, PC Agent, Managed Node, Endpoint: IBM-compatible PCs 486 or higher running Microsoft Windows NT, Versions 3.51 SP5, 4.0, and 4.0 SP3. x Version 3.6

15 TME 10 Software Distribution Icons Preface The following icons represent TME 10 Software Distribution profile resources: File package and AutoPack profile resources are created in the context of a profile manager and are distributed to subscribing systems or profile managers managed by TME 10. Contacting Customer Support If you encounter difficulties with any Tivoli products, you can enter to view the Tivoli Support home page. After you link to and submit the customer registration form, you will be able to access many customer support services on the Web. Use the following phone numbers to contact customer support in the United States: the Tivoli number is (1-800-TIVOLI8) and the IBM number is (press or say 8 after you reach this number). Both of these numbers direct your call to the Tivoli Customer Support Call Center. We are very interested in hearing from you about your experience with Tivoli products and documentation. We welcome your suggestions for improvements. If you have comments or suggestions about this documentation, please send to pubs@tivoli.com. TME 10 Software Distribution Reference Manual xi

16 Preface xii Version 3.6

17 1 1File Package Definitions File Package Definitions TME 10 Software Distribution enables you to set file package properties using the desktop, command line, or by exporting/importing files. When you export a file package, Software Distribution generates the file package definition, which you can edit to change the characteristics of the file package. This file package definition is an ASCII file that contains the following characteristics of the file package: Processing options Logging options Platform-specific options Files and directories in the file package Nested file packages in the file package Files to exclude from the file package The source host, targets, and file package attributes are not included in the file package definition. TME 10 Software Distribution Reference Manual 1 1

18 File Package Definition Format File Package Definition Format header The file package definition is comprised of a header and four sections keyword options, files and directories to be distributed, nested file packages, and excluded files. Each section is delimited by a % (percent), as illustrated here: keyword options files and directories (flist) nested file packages exclude files If the file package definition does not contain a header, or if the format of the header is unlike the header illustrated above (with the exception of version numbers), a fatal error will result and Software Distribution will stop the distribution or removal operation. However, you can create a partial file package definition, containing the header, the three section delimiters, and only those keywords to be set, and import it into the file package. Blank lines and comments in the file package definition are ignored. Items can span multiple lines by ending a line with a backslash (\). The following sections describe each section of the file package definition. 1 2 Version 3.6

19 Keyword Options Section File Package Definition Format The keyword options section contains a complete list of keywords, which control the behavior of a file package distribution, and their default values. The format for this section is the keyword, followed by an equal sign (=) and the value for that keyword, as follows: keyword=value Do not include spaces around the equal sign. If a keyword is not set, nothing follows the equal sign nd Software Distribution uses the default value specified for this parameter. If you want to specify multiple values for a keyword, you must enclose the assigned values in single quotation marks (' '), as follows: File Package Definitions mail_id='user1@example.com user2@example.com' If you do not surround the pairs with single quotation marks, you may receive a misleading diagnostic message while importing the definition similar to the following message: Invalid file package definition: Error: Line 35: Expected '=' assignment. Because keyword=value pairs are separated by spaces, the file package parsing code expects a new keyword assignment after a space and, therefore, expects an equal sign (=) before the new line. The valid keywords and their values are discussed in Keywords on page 1-8. Files and Directories Section The second section of the file package definition, called the flist, contains the names of the files and directories to be distributed (or removed) by the file package. Specifically, the flist can contain the following: TME 10 Software Distribution Reference Manual 1 3

20 File Package Definition Format The path of a file. Directories and file names may contain wildcard characters. The supported wildcard characters are similar to that of the Bourne shell, such as * Matches any string, including the null string.? Matches any single character. [...] Matches any one of the enclosed characters. Also, a backslash (\) may be used as a directory delimiter in the path of a file name. The path of a directory. TME 10 Software Distribution distributes the directory and its contents if the Descend into directories check box is selected in the General Options section. If you wish to distribute all contents of the /tmp/hpux directory but do not want hpux added to the destination path, specify /tmp/hpux/ as the source directory (with the trailing slash). Finally, if you do not select the Descend into directories option, only the directory is distributed. Note: TME 10 Software Distribution supports the UNIX /. path name convention, which specifies that all contents of the directory are to be included, only if you select the Descend into directories check box during the distribution. A shell command surrounded by grave accent marks (`). When the file package is distributed, the shell command is interpreted. Thus, the shell command must produce a valid list of files or directories, one per line. Commonly used commands include find, cat, and ls -l. Each entry is listed one per line, as follows: /src/gnu /etc/host /etc/group 'cat /tmp/filenames' You can also specify one or more options for each line in the flist. Options affect the file name, directory name, or shell command for which they are specified and alter the way the file or directory is processed. The flist options are as follows: 1 4 Version 3.6

21 d g G m M o s t u U File Package Definition Format Specifies the destination path and overrides the value for both the default_dest and xxx_platform_prefix keywords. The last path component from the source path is concatenated to the destination path to form the path. If the source is a directory, all paths in the hierarchy are also modified. Specifies the file GID as a name or number. Specifies the directory GID as a name or number. Specifies the file chmod options, in octal values only. Specifies the directory chmod options, in octal values only. Specifies whether to descend into directories and override the descend_dirs keyword. Valid values are descend and nodescend. Overrides the src_relpath keyword and specifies a path on the source host from which to obtain the file and directory. Sets the modification time given in the format of the date command. Specifies the file UID as a name or number. Specifies the directory UID as a name or number. File Package Definitions Specify an option in the following format after the file name, directory path, or shell command: option=value Do not type spaces around the equal sign (=). List all options on the same line. For example, suppose you specify the following flist in the file package definition: /etc/hosts d=/usr/safe /etc/passwd d=/tmp README.txt s=/usr/local d=/etc TME 10 Software Distribution Reference Manual 1 5

22 File Package Definition Format If you have specified the following keywords in the keywords section of the file package definition: default_dest=/ keep_paths=n src_relpath=/ The README.txt file is obtained from the /usr/local directory and the specified files are distributed as follows: /usr/safe/hosts /tmp/passwd /etc/readme.txt In addition, the following examples are valid entries: /etc/passwd d=/backups/etc u=root /bin/miscdir U=201 G=30 o=descend /bin/file_ex t= m=0600 Finally, consider the following information when specifying the flist: All file and directory entries should be full paths (not relative paths), unless you have specified the src_relpath keyword. See Keywords on page 1-8 for more information on defining keywords. In addition, you must specify the path using forward slashes (/), even if the file or directory resides on a PC. Double-quote any entry that contains an embedded space or an equal sign (=). You cannot specify an option in conjunction with an entry that contains a wildcard character. Because some PCs limit file names to eight characters and file name extensions to three characters, you must specify all files that will be distributed or processed on a PC target in this format. If you specify a file to be distributed or removed whose name is too long, Software Distribution will truncate the file name on the PC target. Environment variables are not allowed. You cannot include a file or directory named TRAILER!!! in the file package. This is the POSIX-compliant cpio end-of-archive file marker. 1 6 Version 3.6

23 Nested File Packages Section File Package Definition Format The third section of the file package definition contains a list of file package names, one per line, that are nested in the current file package. The contents of these nested file packages are distributed (or removed) when the parent file package is distributed (or removed). When file packages are nested, all operations performed on the parent file package are performed on the nested files. The nested file package inherits most of the properties from the parent file package; the characteristics of the parent file package apply to itself and all of its nested file packages. Note: You can only add 50 levels of nested directories to a file package. If a file package name contains special characters, such as white space (for example, FP 1), you must enclose the name in double quotes, as follows: File Package Definitions % "FP 1" Payroll "WP Man Pages" "Database!" Exclude Files Section This section provides an easy way for you to exclude files from the file package operation. When you perform an operation, Software Distribution compares each file in the file package to the entries in the exclude files section. If there is a match, that file is excluded from the file package operation. For example, you might want to distribute everything in the /usr/todd directory except core files or files ending in.o. The exclude files section of the file package would be as follows: % core *.o When you perform a file package operation, if any of the entries in the flist creates a core file or a file that ends with.o, those files are excluded during the operation. TME 10 Software Distribution Reference Manual 1 7

24 Keywords Keywords As illustrated in the previous example, you can specify shell wildcard characters such as *,?, \, [, and ]. In addition, the exclude files list can also contain a shell command surrounded by grave accent marks (`). You can set all of the keywords listed in the file package definition using the export/import capability and most of them using the desktop and command line. The following illustrations map the keywords to various general and platform-specific dialogs when you select these boxes or enter a value in any of these fields, the keyword is set for the file package. In addition, these illustrations provide the Software Distribution defaults to the keywords available through the desktop. Except for those noted, all keywords available through the desktop are listed in the following illustrations. The following dialog sets file package properties for all file packages: stop_on_error descend_dirs keep_paths do_compress default_file_mode post_notice mail_id log_host log_file 1 8 Version 3.6

25 unix_platform_ prefix follow_links Keywords The following dialog sets platform-specific file package options for UNIX file packages: unix_program_ input_from_src unix_program_ prog_from_src File Package Definitions unix_default_ file_uid unix_default_ file_gid unix_program_ prog_path unix_program_ input_path unix_before_ skip_non_zero TME 10 Software Distribution Reference Manual 1 9

26 Keywords The following dialog sets platform-specific file package options for NetWare file packages: nw_platform_ prefix nw_bindery nw_tree nw_context nw_force_ disconnect nw_force_ disconnect nw_broadcast_ message nw_program_ input_from_src nw_login_ get_from_src nw_program_ prog_from_src nw_program_ prog_path nw_login_ prog_path nw_program_ input_path nw_before_ skip_non_zero 1 10 Version 3.6

27 Keywords The following dialog sets platform-specific file package options for Windows file packages: win_platform_ prefix win_optional_ dist win_optional_ dist_timeout File Package Definitions win_program_ prog_from_src win_program_ prog_path win_program_ input_from_src win_program_ input_path win_program_ option Set the win_before_skip_non_zero keyword from the desktop by selecting the Before Distribution button. Also, all of the PC options dialogs are similar. Refer to this illustration to correlate Windows 95, Windows NT, and OS/2 keywords to their respective dialog. TME 10 Software Distribution Reference Manual 1 11

28 Keywords The following dialog illustrates the keyword that is available through the Remove File Packages desktop. rm_empty_dirs The following keywords are listed in the keyword options section of the file package definition. Each keyword is described in terms of its function, the operation it is related to, and the valid values that you can specify. If a keyword has a default value, it is also listed. Keyword Description Related to Valid Values append_log Specifies whether to append a notice to the log file when file package distribution, commit, or removal operations are performed. Reporting or notification y = Append notice to log file n = Replace the log file (default) 1 12 Version 3.6

29 Keyword Description Related to Valid Values backup_fmt Specifies a format used to make a backup of files that exist at the target. Suppose backup_fmt = /back/%p/%f.%n, the file package contains /usr/bin/fp and at distribution time the same file exists on the target, the /usr/bin/fp on the target moves to /back/usr/bin/fp.1. If /back/usr/bin/fp.1 already exists, the original file moves to /back/usr/bin/fp.2, and so on up to a maximum index number of 100. File package processing Keywords An absolute path, optionally containing %p, %f, or %n, where: %p = the directory path %f = the file name %n = an autoincrementing numeric index value There is no default value. File Package Definitions create_dirs Specifies whether to create (at the destination) the intermediate directories for the files in the file package if those directories do not already exist. File package processing y = Create the intermediate directories on the destination (default) n = Do not create new directories TME 10 Software Distribution Reference Manual 1 13

30 Keywords Keyword Description Related to Valid Values default_dest Specifies the default destination directory for all entries in the file package. The destination directory path is constructed as xxx_platform_prefix/ default_dest/filename, where filename is the last component of the file name or the full path (if keep_paths is specified). File package processing Any valid path name. There is no default value. This keyword is useful if you are distributing a file package to different types of machines and want the file package to reside in the same place on all machines. Use the xxx_platform_prefix keywords to specify platform-specific parts of the destination directory, such as a drive letter. default_dir_mode Sets the default permission (mode) for all directories distributed in the file package. Security Any octal mode as described by the chmod man page. Only r (4) and rw (6) are set on PCs. The default is to preserve the mode of the source. default_file_mode Sets the default permission (mode) for all files and links distributed in the file package. Security Any octal mode as described by the chmod man page. Only r (4) and rw (6) are set on PCs. The default is to preserve the mode of the source Version 3.6

31 Keyword Description Related to Valid Values default_mtime Sets the default modification time for all entries distributed in the file package. File package processing Keywords Any number conforming to the date (UNIX) command semantics, which is MMddhhmm[yy]. MM is the month, dd is the day, hh is the hour, mm is the minutes, and yy is the year. You must specify all numbers with two digits; for example, February is 02. The default is the modificaiton time of the original file on the source host. File Package Definitions descend_dirs Specifies whether to traverse directories encountered in the files and directories list, thereby distributing not only the directory entries, but also everything contained in the directories. File package processing y = Distribute named directories and contents n = Distribute only named directories (default) do_checksum Specifies whether to verify a transmission by using a checksum computed on the source and targets. File package processing y = Do checksum n = Do not do checksum (default) do_compress Specifies whether to compress the file package before distributing it. File package processing y = Do compress n = Do not compress (default) TME 10 Software Distribution Reference Manual 1 15

32 Keywords Keyword Description Related to Valid Values dos_after_input_ from_src Provided for backward-compatibility. After DOS targets None dos_after_input_ path Provided for backward-compatibility. After DOS targets None dos_after_option Provided for backward-compatibility. After DOS targets None dos_after_prog_ from_src Provided for backward-compatibility. After DOS targets None dos_after_prog_ path Provided for backward-compatibility. After DOS targets None dos_after_removal_ input_from_src Provided for backward-compatibility. After removal DOS targets None dos_after_removal_ input_path Provided for backward-compatibility. After removal DOS targets None dos_after_removal_ option Provided for backward-compatibility. After removal DOS targets None dos_after_removal_ prog_from_src Provided for backward-compatibility. After removal DOS targets None dos_after_removal_ prog_path Provided for backward-compatibility. After removal DOS targets None 1 16 Version 3.6

33 Keyword Description Related to Valid Values dos_before_input_ from_src dos_before_input_ path Provided for backward-compatibility. Provided for backward-compatibility. Before DOS targets Before DOS targets None None Keywords File Package Definitions dos_before_prog_ from_src Provided for backward-compatibility. Before DOS targets None dos_before_prog_ path Provided for backward-compatibility. Before DOS targets None dos_before_skip_ non_zero Provided for backward-compatibility. Before DOS targets None dos_commit_input_ from_src Provided for backward-compatibility. Commit DOS targets None dos_commit_input_ path Provided for backward-compatibility. Commit DOS targets None dos_commit_option Provided for backward-compatibility. Commit DOS targets None dos_commit_prog_ from_src Provided for backward-compatibility. Commit DOS targets None dos_commit_prog_ path Provided for backward-compatibility. Commit DOS targets None TME 10 Software Distribution Reference Manual 1 17

34 Keywords Keyword Description Related to Valid Values dos_on_error_ input_from_src Provided for backward-compatibility. On error DOS targets None dos_on_error_ input_path Provided for backward-compatibility. On error DOS targets None dos_on_error_ option Provided for backward-compatibility. On error DOS targets None dos_on_error_prog_ from_src Provided for backward-compatibility. On error DOS targets None dos_on_error_prog_ path Provided for backward-compatibility. On error DOS targets None dos_platform_prefix Provided for backward-compatibility. Destination paths on DOS targets None dos_removal_input_ from_src Provided for backward-compatibility. Removal DOS targets None dos_removal_input_ path Provided for backward-compatibility. Removal DOS targets None dos_removal_option Provided for backward-compatibility. Removal DOS targets None dos_removal_prog_ from_src Provided for backward-compatibility. Removal DOS targets None 1 18 Version 3.6

35 Keyword Description Related to Valid Values dos_removal_prog_ path file_cksums Provided for backward-compatibility. Indicates whether to use checksums on the individual files in the file package to detect differences between the source file and the target file rather than just modification time, ownership group membership, and file mode. This is only relevant when any changes are indicated for a distribute or preview operation. Removal DOS targets File package processing None Keywords y = Compute checksum on individual files to detect differences between the source and the target n = Use only modification time, ownership, group membership, and file mode to detect differences between the source and target (default) File Package Definitions follow_links Indicates whether to follow symbolic links to the original files to which the links point, thereby causing the files to be distributed, rather than the links. File package processing y = Copy original files to destination (default) n = Create new links to original files at the destination CAUTION! If you are distributing the file package to PC targets, do not set this keyword to n or the distribution to the PCs will fail if there are symbolic links in the file package definition. TME 10 Software Distribution Reference Manual 1 19

36 Keywords Keyword Description Related to Valid Values install_progs Indicates whether to remove the configuration programs which get unpacked on the target machine (assuming they were specified to come from the source host) after they are run. File package processing y = Install the programs that originate on the source into the destination path defined by xxx_platform_prefix /default_dest n = Install the programs that originate on the source host using temporary names and remove them from the target after processing (default) keep_paths Indicates whether to concatenate the entire source file path name onto the destination file path. For example, sending source file /etc/motd to default destination /target/dist, if keep_paths = y, the file arrives at the targets as /target/dist/etc/motd; otherwise, it arrives as /target/dist/motd. File package processing y = Append path names n = Do not append path names (default) 1 20 Version 3.6

37 list_path Keyword Description Related to Valid Values Specifies the directory on the target in which to write the log file containing a list of all files and directories distributed to or removed from the target. The log file is called fpname.log, where fpname is the name of the file package being distributed or removed. If this directory does not exist, create_dirs=y must be specified to create the directory. File package processing Keywords A fully specified path to a directory. There is no default value. Note: Do not enable this keyword if the file package name has spaces or more than eight characters. File Package Definitions log_file Specifies a complete path to place notice information in when a distribute, commit, or removal is performed. Reporting or notification Complete file path. If the file does not already exist, an attempt is made to create the file with the UID and GID of the administrator performing the operation. The default is no path, indicating no log file. log_file_gid b Specifies the GID of the log file specified by the log_file keyword. Reporting or notification Any decimal value valid as a GID on the source system. The default is the GID of the administrator who first distributed the file package. TME 10 Software Distribution Reference Manual 1 21

38 Keywords Keyword Description Related to Valid Values log_file_mode Specifies the file mode of the log file specified by the log_file keyword. Reporting or notification Any valid octal value. The default is 600, owner readable and writable. log_file_uid b Specifies the UID of the log file specified by the log_file keyword. Reporting or notification Any decimal value valid as a UID on the source system. The default is the UID of the administrator who first distributed the file package. log_host Specifies the name of a managed node where the log file is written. Reporting or notification Name of the managed node. The default is no host name. If a log file is specified but not a log host, the default log host is the TMR server. mail_id Specifies complete addresses of people to send mail to when a distribution, commit, or removal is performed. See the TME 10 Framework Planning and Installation Guide for more info about configuring in your TMR. Reporting or notification Complete addresses, such as joe@work.com, valid on the TMR server. By default, mail is not sent. modifiers For internal use only. File package processing None 1 22 Version 3.6

39 Keyword Description Related to Valid Values nested_first Indicates whether to process the nested file packages before the contents of the file package. File package processing Keywords y = Process nested file packages before the contents of this file package n = Process nested file packages after the contents of this file package (default) File Package Definitions no_overwrite Indicates whether to overwrite a file on the target. File package processing y = Does not overwrite n = Overwrites (default) nt_after_input_ from_src Indicates whether the files specified by the nt_after_input_path keyword resides on the source host. After Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_after_input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_after_prog_path keyword (only valid if you set the nt_after_prog_path keyword). If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_after_prog_path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 23

40 Keywords Keyword Description Related to Valid Values nt_after_option Indicates whether to reboot the target after the program runs, restart Windows NT on the target after the program runs, or neither. If the after program fails, the target is not rebooted or restarted. After Windows NT targets reboot = Reboot the target after the program runs restart = Restart Windows NT after the program runs NULL = Do not reboot, or restart Windows NT (default) nt_after_prog_ from_src Indicates whether the programs specified by the nt_after_prog_ path keyword resides on the source host. After Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_after_prog_path Specifies the full path of programs to be run on a Windows NT target after a file package s files are distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nt_after_removal_ input_from_src Specifies whether the files specified by the nt_after_removal_ input_path keyword resides on the source host. After removal Windows NT targets y = Resides on the source host n = Resides on the target (default) 1 24 Version 3.6

41 Keyword Description Related to Valid Values nt_after_removal_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_after_removal_ prog_path keyword (only valid if you set the nt_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal Windows NT targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_after_removal_ prog_path keyword. The default is no path name. File Package Definitions nt_after_removal_ option Indicates whether to reboot the target after removal completes. If an after removal program is specified and it fails, the target is not rebooted. After removal Windows NT targets reboot = Reboot the target after removal restart = Restart Windows NT after the program runs NULL = Do not reboot (default) nt_after_removal_ prog_from_src Specifies whether the programs specified by the nt_after_removal_ prog_path keyword resides on the source host. After removal Windows NT targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 25

42 Keywords Keyword Description Related to Valid Values nt_after_removal_ prog_path Specifies a full path of a program to be run on a Windows NT target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal Windows NT targets Any valid, complete file name. The default is no path name (that is, do not run a program after removing a file package). nt_before_input_ from_src Indicates whether the files specified by the nt_before_input_path keyword resides on the source host. Before Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_before_input_ path Specifies a full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_before_prog_path keyword (only valid if you set the nt_before_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_before_prog_ path keyword. The default is no path name Version 3.6

43 Keyword Description Related to Valid Values nt_before_prog_ from_src Yes or no toggle that indicates whether the programs specified by the nt_before_prog_path keyword resides on the source host. Before Windows NT targets y = Resides on the source host n = Resides on the target (default) Keywords File Package Definitions nt_before_prog_ path Specifies the full path of programs to be run on a Windows NT target before the file package is distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Before Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nt_before_skip_ non_zero Indicates whether to skip the distribution to an NT target (not performed) if the programs specified by the nt_before_prog_path keyword exits with a nonzero exit code. Before Windows NT targets y = Skip n = Do not skip (default) nt_commit_input_ from_src Indicates whether the files specified by the nt_commit_input_ path keyword resides on the source host. Commit Windows NT targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 27

44 Keywords Keyword Description Related to Valid Values nt_commit_input_ path Specifies a full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_commit_prog_path keyword (only valid if you set the nt_commit_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_commit_prog_ path keyword. The default is no path name. nt_commit_option Indicates whether to reboot the target after the commit operation completes, restart Windows NT on the target after the commit operation completes, or neither. If the commit program fails, a reboot or restart will not be performed. Commit Windows NT targets reboot = Reboot the target after the program runs restart = Restart Windows NT after the program runs NULL = Do not reboot, or restart Windows NT (default) nt_commit_prog_ from_src Indicates whether the programs specified by the nt_commit_prog_path keyword resides on the source host. Commit Windows NT targets y = Resides on the source host n = Resides on the target (default) 1 28 Version 3.6

45 Keyword Description Related to Valid Values nt_commit_prog_ path Specifies the full path of programs to be run on an NT target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit Windows NT targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions nt_on_error_input_ from_src Specifies whether the files specified by the nt_on_error_input_pa th keyword resides on the source host. On error Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_on_error_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_on_error_prog_ path keyword (only valid if you set the nt_on_error_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_on_error_prog_ path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 29

46 Keywords Keyword Description Related to Valid Values nt_on_error_option Indicates whether to reboot or restart the target after the on error program runs. If an on error program is specified and it fails, the target is not rebooted. On error Windows NT targets reboot = Reboot the target restart = Restart Windows NT after the program runs NULL = Do not reboot (default) nt_on_error_prog_ from_src Specifies whether the programs specified by the nt_on_error_prog_ path keyword resides on the source host. On error Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_on_error_prog_ path Specifies a full path of a program to be run on a Windows NT target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nt_platform_prefix Specifies a destination path for a PCs running Windows NT. Destination paths on Windows NT targets A path that is added to the beginning of each destination path (as specified by default_dest) on NT targets. There is no default value Version 3.6

47 Keyword Description Related to Valid Values nt_removal_input_ from_src nt_removal_input_ path Indicates whether the files specified by the nt_removal_input_ path keyword resides on the source host. Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the nt_removal_prog_ path keyword (only valid if you set the nt_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution and obtains the input files from the path specified by the src_relpath keyword. Removal Windows NT targets Removal Windows NT targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nt_removal_prog_ path keyword. The default is no path name. File Package Definitions nt_removal_option Indicates whether to reboot the target after the removal, restart Windows NT on the target after removal, or neither. If the removal program fails, a reboot or restart will not be performed. Removal Windows NT targets reboot = Reboot the target after the program runs restart = Restart Windows NT after the program runs NULL = Do not reboot, or restart Windows NT (default) TME 10 Software Distribution Reference Manual 1 31

48 Keywords Keyword Description Related to Valid Values nt_removal_prog_ from_src Indicates whether the programs specified by the nt_removal_prog_pat h keyword resides on the source host. Removal Windows NT targets y = Resides on the source host n = Resides on the target (default) nt_removal_prog_ path Specifies the full path of programs to be run on the Windows NT target before removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal Windows NT targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nw_after_input_ from_src Indicates whether the files specified by the nw_after_input_path keyword resides on the source host. After NetWare targets y = Resides on the source host n = Resides on the target (default) 1 32 Version 3.6

49 Keyword Description Related to Valid Values nw_after_input_ path Specifies the full path of files whose name is to be passed as the second argument (argv [2]) to the NLM or.ncf files specified by the nw_after_prog_path keyword (only valid if you set the nw_after_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After NetWare targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_after_prog_pat h keyword. The default is no path name. File Package Definitions nw_after_prog_ from_src Indicates whether the programs specified by the nw_after_prog_path keyword resides on the source host. After NetWare targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 33

50 Keywords Keyword Description Related to Valid Values nw_after_prog_ path a Specifies the full path of NLM or.ncf files to be run on a NetWare target after a file package s files are distributed. If the programs and input files reside on the source host, you can specify a relative path to them. Software Distribution runs the programs and obtains the input files from the path specified by the src_relpath keyword. After NetWare targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nw_after_removal_ input_from_src Specifies whether the files specified by the nw_after_removal_ input_path keyword resides on the source host. After removal NetWare targets y = Resides on the source host n = Resides on the target (default) 1 34 Version 3.6

51 Keyword Description Related to Valid Values nw_after_removal_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the NLM or.ncf files specified by the nw_after_removal_ prog_path keyword (only valid if you set the nw_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal NetWare targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_after_removal_ prog_path keyword. The default is no path name. File Package Definitions nw_after_removal_ prog_from_src Specifies whether the programs specified by the nw_after_removal_ prog_path keyword resides on the source host. After removal NetWare targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 35

52 Keywords Keyword Description Related to Valid Values nw_after_removal_ prog_patha Specifies a full path of NLM or.ncf files to be run on a NetWare target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal NetWare targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nw_before_input_ from_src Indicates whether the files specified by the nw_before_input_path keyword resides on the source host. Before NetWare targets y = Resides on the source host n = Resides on the target (default) nw_before_input_ path Specifies the full path of files to be passed as the second argument (argv [2]) to the NLM or.ncf files specified by the nw_before_prog_path keyword (only valid if you set the nw_before_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before NetWare targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_before_prog_ path keyword. The default is no path name Version 3.6

53 Keyword Description Related to Valid Values nw_before_prog_ from_src nw_before_prog_ path a Indicates whether the programs specified by the nw_before_prog_path keyword resides on the source host. Specifies the full path of NLM or.ncf files to be run on a NetWare target before the file package is distributed. If the programs and input files reside on the source host, you can specify a relative path to them. Software Distribution runs the programs and obtains the input files from the path specified by the src_relpath keyword. Before NetWare targets Before NetWare targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions nw_before_skip_ non_zero Indicates whether the distribution to the NetWare target should be skipped (not performed) if the programs specified by the nw_before_prog_path keyword exits with a nonzero exit code. Before NetWare targets y = Skip n = Do not skip (default) TME 10 Software Distribution Reference Manual 1 37

54 Keywords Keyword Description Related to Valid Values nw_bindery Indicates whether to login to the NetWare 4.1 server in bindery mode, thus, emulating a NetWare 3.x machine. If you set this keyword and bindery emulation is off on the NetWare server, the Directory Services account is used with the nw_context and nw_tree keywords. File package processing y = Login in bindery mode n = Do not login in bindery mode (default) nw_broadcast_ message Specifies the message that is broadcast to NetWare clients connected to the NetWare server prior to the distribution to the server. File package processing A string of up to 255 chars that is broadcast to NetWare targets of the distribution. You do not need to include newlines in the message; the agent formats it. There is no default value nw_broadcast_mode Specifies whether to broadcast the message specified by the nw_broadcast_ message keyword to all NetWare clients connected to the NetWare server or only those clients that have locked files which will be distributed to the server. File package processing y = Broadcast the message to all NetWare targets (default) n = Broadcast the message to only those targets that have locked files that will be distributed 1 38 Version 3.6

55 Keyword Description Related to Valid Values nw_commit_input_ from_src nw_commit_input_ path Indicates whether the files specified by the nw_commit_input_ path keyword resides on the source host. Specifies the full path of files to be passed as the second argument (argv [2]) to the NLM or.ncf files specified by the nw_commit_prog_ path keyword (only valid if you set the nw_commit_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit NetWare targets Commit NetWare targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_commit_prog_ path keyword. The default is no path name. File Package Definitions nw_commit_prog_ from_src Indicates whether the programs specified by the nw_commit_prog_ path keyword resides on the source host. Commit NetWare targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 39

56 Keywords Keyword Description Related to Valid Values nw_commit_prog_ path a Specifies the full path of NLM or.ncf files to be run on a NetWare target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit NetWare targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nw_context Specifies the directory services context for a distribution to a NetWare 4.1 server. If this keyword is not specified, the default context for the target server as specified in the TMEAGENT.CFG file is used. File package processing A string that specifies a valid directory services context on the target server. There is no default value. nw_force_disconnect Specifies whether to break a lock on a file and replace the file during a distribution to a NetWare target. File package processing y = Break the lock and replace the file n = Do not break the lock or replace the file (default) nw_on_error_ input_from_src Specifies whether the files specified by the nw_on_error_input_ path keyword resides on the source host. On error NetWare targets y = Resides on the source host n = Resides on the target (default) 1 40 Version 3.6

57 Keyword Description Related to Valid Values nw_on_error_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the NLM or.ncf files specified by the nw_on_error_prog_ path keyword (only valid if you set the nw_on_error_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error NetWare targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_on_error_prog_ path keyword. The default is no path name. File Package Definitions nw_on_error_prog_ from_src Specifies whether the programs specified by the nw_on_error_prog_ path keyword resides on the source host. On error NetWare targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 41

58 Keywords Keyword Description Related to Valid Values nw_on_error_prog_ path a Specifies a full path of NLM or.ncf files to be run on a NetWare target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error NetWare targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. nw_platform_prefix Specifies a destination path for NetWare targets. Destination paths on NetWare targets A path that is added to the beginning of each destination path (as specified by default_dest) on NetWare targets. There is no default value. nw_removal_input_ from_src Indicates whether the files specified by the nw_removal_input_ path keyword resides on the source host. Removal NetWare targets y = Resides on the source host n = Resides on the target (default) 1 42 Version 3.6

59 Keyword Description Related to Valid Values nw_removal_input_ path Specifies the full path of files to be passed as the second argument (argv[2]) to the NLM or.ncf files specified by the nw_removal_prog_ path keyword (only valid if you set the nw_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Removal NetWare targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the nw_removal_prog_ path keyword. The default is no path name. File Package Definitions nw_removal_prog_ from_src Indicates whether the programs specified by the nw_removal_prog_ path keyword resides on the source host Removal NetWare targets y = Resides on the source host n = Resides on the target (default) nw_removal_prog_ path a Specifies the full path of NLM or.ncf files to be run on a NetWare target before removing a file package from the targets. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal NetWare targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. TME 10 Software Distribution Reference Manual 1 43

60 Keywords Keyword Description Related to Valid Values nw_tree Specifies a directory services tree to which to distribute a file package on a NetWare target. If this keyword is not specified, the default tree for the target server as specified in the TMEAGENT.CFG file is used. File package processing A string that specifies a valid directory service tree on the NetWare target. There is no default value. os2_after_input_ from_src Indicates whether the files specified by the os2_after_input_path keyword resides on the source host. After OS/2 targets y = Resides on the source host n = Resides on the target (default) os2_after_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the os2_after_prog_path (only valid if you set the os2_after_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_after_prog_ path keyword. The default is no path name. os2_after_option Provided for future use. After OS/2 targets None 1 44 Version 3.6

61 Keyword Description Related to Valid Values os2_after_prog_ from_src os2_after_prog_ path Indicates whether the programs specified by the os2_after_prog_path keyword resides on the source host. Specifies the full path of programs to be run on an OS/2 target after a file package s files are distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After OS/2 targets After OS/2 targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions os2_after_removal_ input_from_src Specifies whether the files specified by the os2_after_removal_ input_path keyword resides on the source host. After removal OS/2 targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 45

62 Keywords Keyword Description Related to Valid Values os2_after_removal_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the os2_after_removal_ prog_path keyword (only valid if you set the os2_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_after_removal_ prog_path keyword. The default is no path name. os2_after_removal_ option Provided for future use. After removal OS/2 targets None os2_after_removal_ prog_from_src Specifies whether the programs specified by the os2_after_removal_ prog_path keyword resides on the source host. After removal OS/2 targets y = Resides on the source host n = Resides on the target (default) 1 46 Version 3.6

63 Keyword Description Related to Valid Values os2_after_removal_ prog_path Specifies a full path of programs to be run on an OS/2 target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal OS/2 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions os2_before_input_ from_src Indicates whether the files specified by the os2_before_input_ path keyword resides on the source host. Before OS/2 targets y = Resides on the source host n = Resides on the target (default) os2_before_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the os2_before_prog_path keyword (only valid if you set the os2_before_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_before_prog_ path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 47

64 Keywords Keyword Description Related to Valid Values os2_before_prog_ from_src Indicates whether the programs specified by the os2_before_prog_path keyword resides on the source host. Before OS/2 targets y = Resides on the source host n = Resides on the target (default) os2_before_prog_ path Specifies the full path of programs to be run on an OS/2 target before the file package is distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Before OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. os2_before_skip_ non_zero Indicates whether the distribution to the OS/2 target should be skipped (not performed) if the program specified by the os2_before_prog_path keyword exits with a nonzero exit code. Before OS/2 targets y = Skip n = Do not skip (default) os2_commit_input_ from_src Indicates whether the files specified by the os2_commit_input_ path keyword resides on the source host. Commit OS/2 targets y = Resides on the source host n = Resides on the target (default) 1 48 Version 3.6

65 Keyword Description Related to Valid Values os2_commit_input_ path Specifies the full path of a file to be passed as the second argument (argv[2] or %2) to os2_commit_prog_ path (only meaningful if os2_commit_prog_ path is set). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit OS/2 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_commit_prog_ path keyword. The default is no path name. File Package Definitions os2_commit_option Provided for future use. Commit OS/2 targets None os2_commit_prog_ from_src Indicates whether the program specified by the os2_commit_prog_ path keyword resides on the source host. Commit OS/2 targets y = Resides on the source host n = Resides on the target (default) os2_commit_prog_ path Specifies the full path of programs to be run on each OS/2 target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. TME 10 Software Distribution Reference Manual 1 49

66 Keywords Keyword Description Related to Valid Values os2_on_error_ input_from_src Specifies whether the files specified by the os2_on_error_input_ path keyword resides on the source host. On error OS/2 targets y = Resides on the source host n = Resides on the target (default) os2_on_error_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the os2_on_error_prog_ path keyword (only valid if you set the os2_on_error_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_on_error_ prog_path keyword. The default is no path name. os2_on_error_ option Provided for future use. On error OS/2 targets None os2_on_error_prog_ from_src Specifies whether the programs specified by the os2_on_error_prog_ path keyword resides on the source host. On error OS/2 targets y = Resides on the source host n = Resides on the target (default) 1 50 Version 3.6

67 Keyword Description Related to Valid Values os2_on_error_prog_ path Specifies a full path of programs to be run on an OS/2 target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error OS/2 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions os2_platform_prefix Specifies a destination path for PCs running OS/2. Destination paths on OS/2 targets A path that is added to the beginning of each destination path (as specified by default_dest) on OS/2 targets. There is no default value. os2_removal_input_ from_src Indicates whether the files specified by the os2_removal_input_ path keyword resides on the source host. Removal OS/2 targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 51

68 Keywords Keyword Description Related to Valid Values os2_removal_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the os2_removal_prog_ path keyword (only valid if you set the os2_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Removal OS/2 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the os2_removal_prog_ path keyword. The default is no path name. os2_removal_option Provided for future use. Removal OS/2 targets None os2_removal_prog_ from_src Indicates whether the programs specified by the os2_removal_prog_ path keyword resides on the source host. Removal OS/2 targets y = Resides on the source host n = Resides on the target (default) 1 52 Version 3.6

69 Keyword Description Related to Valid Values os2_removal_prog_ path Specifies the full path of programs to be run on an OS/2 target before removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal OS/2 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions post_notice Indicates whether to post notices to the Software Distribution notice group when file package distribution, commit, or removal operations are performed. Reporting or notification y = Post notice (default) n = Do not post notice postproc Provides a means of encoding data for file packages. You can specify a processing filter to encrypt file package data just before it leaves the source host. This keyword must be used in conjunction with the preproc keyword. File package encryption processing on UNIX targets Any string without embedded new-lines. This option is ignored on PCs. There is no default value. TME 10 Software Distribution Reference Manual 1 53

70 Keywords Keyword Description Related to Valid Values preproc Provides a means of decoding data for file packages. You can specify a processing filter to decrypt the file package as it arrives at the target. This keyword must be used in conjunction with the postproc keyword. File package decryption processing on UNIX targets Any string without embedded new-lines. This option is ignored on PCs. There is no default value. prog_env Specifies a string that will be the subject of a putenv before any configuration program is run on a UNIX machine. The string is a list of name=value pairs. Given a file package named GNU Emacs with a unix_platform_prefix of /usr/local/bin/gnu, consider the following example: prog_env= DEST= $unix_platform_prefix FPNAME= $fpname Within a configuration program, $DEST would be /usr/local/bin/gnu and $FPNAME would be GNU Emacs. Configuration programs on UNIX targets Any environment variable value. You can provide a variable name that matches any file package keyword. These are expanded into the file package s value for the keyword. Note: The file package name is not a keyword; $fpname is supported as a special string because most configuration programs need access to the file package name. There is no default value Version 3.6

71 Keyword Description Related to Valid Values progs_timeout Sets a timeout value for all configuration programs specified in the file package. This timeout value is only recognized on endpoints. Configuration programs on endpoints Keywords Any decimal value. The default is -l, enabling the configuration program to run until completion (no timeout). File Package Definitions rm_empty_dirs Indicates whether to remove all empty target directories at the targets after a file package is removed. Empty directories are removed up to, but not including xxx_platform_prefix + default_dest. File package processing y = Remove empty directories n = Do not remove empty directories (default) rm_extraneous Indicates whether to remove all files and directories in an existing destination directory prior to installing a file package. File package processing y = Remove extraneous files n = Do not remove extraneous files (default) skip_older_src Indicates whether to overwrite a target file if it is newer than the source file. File package processing y = Do not overwrite the target file with the source file if the source file is older n = Overwrite the target file with the source file regardless of which one is older (default) src_after_as_uid b Specifies the UID of the user under which to run src_after_prog_path. After the source host Any decimal value valid as a UID on the source system. The default is to run as root. TME 10 Software Distribution Reference Manual 1 55

72 Keywords Keyword Description Related to Valid Values src_after_input_ path Specifies files to be passed through standard input to the programs specified by the src_after_prog_path keyword (only valid if you set the src_after_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. If the input files reside on the target, you must specify a full path to each. After the source host One or more valid file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the src_after_prog_ path keyword. The default is no path name. src_after_prog_ path Specifies programs to be run on the source host after the file package is distributed to the targets. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. If the programs reside on the target, you must specify a full path to each. After the source host One or more valid file names, separated by commas (no spaces). The default is no path name Version 3.6

73 Keyword Description Related to Valid Values src_before_as_uid b src_before_input_ path Specifies the UID of the user under which to run the programs specified by the src_before_prog_path keyword. Specifies files to be passed through standard input to the programs specified by the src_before_prog_path keyword (only valid if you set the src_before_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. If the input files reside on the target, you must specify a full path to each. Before the source host Before the source host Keywords Any decimal value valid as a UID on the source system. The default is to run as root. One or more valid file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the src_before_prog_ path keyword. The default is no path name. File Package Definitions TME 10 Software Distribution Reference Manual 1 57

74 Keywords Keyword Description Related to Valid Values src_before_prog_ path Specifies programs to be run on the source host before the file package is distributed to the targets. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. If the programs reside on the target, you must specify a full path to each. Before the source host One or more valid file names, separated by commas (no spaces). The default is no path name. src_before_skip_ non_zero Indicates whether the distribution to the target should be skipped (not performed) if the programs specified by the src_before_prog_path keyword exits with a nonzero exit code. Before the source host y = Skip n = Do not skip (default) 1 58 Version 3.6

75 Keyword Description Related to Valid Values src_relpath Specifies the path on the source host from which relative files and directories in the file package are obtained. You can specify programs and input files that reside on the source host with relative paths. Software Distribution adds the path specified by this keyword to the beginning of the paths of the programs or input files. File package processing Keywords A full path on the source host. There is no default value. File Package Definitions stop_on_error Indicates whether to stop processing to the target if an error occurs while distributing or removing to the target. File package processing y = Stop processing in the event of an error (default) n = Do not stop processing in the event of an error unix_after_as_uid b Specifies the UID of the user under which to run the programs specified by the unix_after_prog_path keyword. After UNIX targets Any decimal value valid as a UID on the target systems. The default is to run as root. unix_after_input_ from_src Indicates whether the files specified by the unix_after_input_path keyword resides on the source host After UNIX targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 59

76 Keywords Keyword Description Related to Valid Values unix_after_input_ path Specifies the full path of files to be passed through standard input to the programs specified by the unix_after_prog_path keyword (only valid if you set the unix_after_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After UNIX targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_after_prog_ path keyword. The default is no path name. unix_after_ prog_from_src Indicates whether the programs specified by the unix_after_prog_path keyword resides on the source host. After UNIX targets y = Resides on the source host n = Resides on the target (default) unix_after_prog_ path Specifies the full path of programs to be run on a UNIX target after a file package s files are applied to that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After UNIX targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name Version 3.6

77 Keyword Description Related to Valid Values unix_after_removal_ as_uid b unix_after_removal_ input_from_src Specifies the UID of the user under which to run the program specified by the unix_after_removal_ prog_path keyword. Specifies whether the files specified by the unix_after_removal_ input_path keyword resides on the source host. After removal UNIX targets After removal UNIX targets Keywords Any decimal value valid as a UID on the target systems. The default is to run as root. y = Resides on the source host n = Resides on the target (default) File Package Definitions unix_after_ removal_input_path Specifies the full path of files to be passed through standard input to the programs specified by the unix_after_removal_ prog_path keyword (only valid if you set the unix_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal UNIX targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_after_ removal_prog_path keyword. The default is no path name. unix_after_ removal_prog_ from_src Specifies whether the programs specified by the unix_after_removal_ prog_path keyword resides on the source host. After removal UNIX targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 61

78 Keywords Keyword Description Related to Valid Values unix_after_ removal_prog_path Specifies a full path of programs to be run on a UNIX target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal UNIX targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. unix_before_as_ uid b Specifies the UID of the user under which to run the program specified by the unix_before_prog_ path keyword. Before UNIX targets Any decimal value valid as a UID on the target system. The default is to run as root. unix_before_input_ from_src Indicates whether the files specified by the unix_before_input_ path keyword resides on the source host. Before UNIX targets y = Resides on the source host n = Resides on the target (default) 1 62 Version 3.6

79 Keyword Description Related to Valid Values unix_before_input_ path Specifies the full path of files to be passed through standard input to the programs specified by the unix_before_prog_ path keyword (only valid if you set the unix_before_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before UNIX targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_before_prog_ path keyword. The default is no path name. File Package Definitions unix_before_ prog_from_src Indicates whether the programs specified by the unix_before_prog_ path keyword resides on the source host. Before UNIX targets y = Resides on the source host. n = Resides on the target (default) unix_before_ prog_path Specifies the full path of programs to be run on each UNIX target before a file package s files are distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Before UNIX targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. TME 10 Software Distribution Reference Manual 1 63

80 Keywords Keyword Description Related to Valid Values unix_before_ skip_non_zero Indicates whether to skip (not perform) the application of a file package s files to a UNIX target if the unix_before_prog_ path program that runs on that target exits with a nonzero exit code. Before UNIX targets y = Skip n = Do not skip (default) unix_commit_as_ uid b Specifies the UID under which to run the program specified by the unix_commit_prog_ path keyword. Commit UNIX targets Any decimal value valid as a UID on the target system. The default is to run as root. unix_commit_ input_from_src Indicates whether the files specified by the unix_commit_input_ path keyword resides on the source host. Commit UNIX targets y = Resides on the source host n = Resides on the target (default) unix_commit_ input_path Specifies the full path of files to be passed through standard input to the programs specified by the unix_commit_prog_ path keyword (only valid if you set the unix_commit_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit UNIX targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_commit_prog_ path keyword. The default is no path name Version 3.6

81 Keyword Description Related to Valid Values unix_commit_prog_ from_src unix_commit_prog_ path Indicates whether the programs specified by the unix_commit_prog_ path keyword resides on the source host. Specifies the full path of programs to be run on each UNIX target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit UNIX targets Commit UNIX targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions unix_default_dir_ gid b Specifies the default GID for all directories distributed in the file package. Security on UNIX targets Any decimal number valid as a GID on the target system or the name of a group on the TMR server. The default is to preserve the GID of the source. unix_default_dir_ uid b Specifies the default UID for all directories distributed in the file package. Security on UNIX targets Any decimal number valid as a UID on the target system or the name of a user on the TMR server. The default is to preserve the UID of the source. TME 10 Software Distribution Reference Manual 1 65

82 Keywords Keyword Description Related to Valid Values unix_default_file_ gid b Specifies the default GID for all files and links distributed in the file package. Security on UNIX targets Any decimal number valid as a GID on the target system or the name of a group on the TMR server. The default is to preserve the GID of the source. unix_default_file_ uid b Specifies the default UID for all files and links distributed in the file package. Security on UNIX targets Any decimal number valid as a user id on the target system or the name of a user on the TMR server. The default is to preserve the UID of the source. unix_on_error_as_ uid b Specifies the UID of the user under which to run the programs specified by the unix_on_error_prog_ path keyword. On error UNIX targets Any decimal value valid as a UID on the target systems. The default is to run as root. unix_on_error_ input_from_src Specifies whether the files specified by the unix_on_error_input_ path keyword resides on the source host. On error UNIX targets y = Resides on the source host n = Resides on the target (default) 1 66 Version 3.6

83 Keyword Description Related to Valid Values unix_on_error_ input_path Specifies the full path of files to be passed through standard input to the programs specified by the unix_on_error_prog_ path keyword (only valid if you set the unix_on_error_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error UNIX targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_on_error_pro g_path keyword. The default is no path name. File Package Definitions unix_on_error_ prog_from_src Specifies whether the programs specified by the unix_on_error_prog_ path keyword resides on the source host. On error UNIX targets y = Resides on the source host n = Resides on the target (default) unix_on_error_ prog_path Specifies a full path of programs to be run on a UNIX target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error UNIX targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. TME 10 Software Distribution Reference Manual 1 67

84 Keywords Keyword Description Related to Valid Values unix_platform_ prefix Specifies a destination path for UNIX targets. Destination paths on UNIX targets A path that is added to the beginning of each destination path (as specified by default_dest) on UNIX targets. There is no default value. unix_removal_as_ uid b Specifies the UID of the under which to run the programs specified by the unix_removal_prog_ path keyword. Removal UNIX targets Any decimal value valid as a UID on the target system. The default is to run as root. unix_removal_ input_from_src Indicates whether the files specified by the unix_removal_input_ path keyword resides on the source host. Removal UNIX targets y = Resides on the source host n = Resides on the target (default) unix_removal_ input_path Specifies the full path of files to be passed through standard input to the programs specified by the unix_removal_prog_ path keyword (only valid if you set the unix_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Removal UNIX targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the unix_removal_ prog_path keyword. The default is no path name Version 3.6

85 Keyword Description Related to Valid Values unix_removal_ prog_from_src unix_removal_ prog_path Indicates whether the programs specified by the unix_removal_prog_ path keyword resides on the source host. Specifies the full path of programs to be run on a UNIX target before removing a file package s files from those targets. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal UNIX targets Removal UNIX targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions win_after_input_ from_src Indicates whether the files specified by the win_after_input_path keyword resides on the source host. After Windows targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 69

86 Keywords Keyword Description Related to Valid Values win_after_input_ path Specifies a full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_after_prog_path keyword (only valid if you set the win_after_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_after_prog_ path keyword. The default is no path name. win_after_option Indicates whether to reboot the target after the program runs, restart Windows on the target after the program runs, or neither. If the after program fails, a reboot or restart will not be performed. After Windows targets reboot = Reboot the target after the program runs restart = Restart Windows after the program runs NULL = Do not reboot, or restart Windows (default) win_after_prog_ from_src Indicates whether the programs specified by the win_after_prog_path keyword resides on the source host. After Windows targets y = Resides on the source host n = Resides on the target (default) 1 70 Version 3.6

87 Keyword Description Related to Valid Values win_after_prog_ path Specifies the full path of programs to be run on a Windows target after a file package s files are distributed. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After Windows targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions win_after_removal_ input_from_src Specifies whether the files specified by the win_after_removal_ input_path keyword resides on the source host. After removal Windows targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 71

88 Keywords Keyword Description Related to Valid Values win_after_removal_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_after_removal_ prog_path keyword (only valid if you set the win_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_after_removal_ prog_path keyword. The default is no path name. win_after_removal_ option Indicates whether to reboot the target after the program runs, restart Windows on the target after the program runs, or neither. If the after_removal program fails, the target is not rebooted or restarted. After removal Windows targets reboot = Reboot the target after the program runs restart = Restart Windows after the program runs NULL = Do not reboot, or restart Windows (default) win_after_removal_ prog_from_src Specifies whether the programs specified by the win_after_removal_ prog_path keyword resides on the source host. After removal Windows targets y = Resides on the source host n = Resides on the target (default) 1 72 Version 3.6

89 Keyword Description Related to Valid Values win_after_removal_ prog_path Specifies a full path of programs to be run on each Windows target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal Windows targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions win_before_input_ from_src Indicates whether the files specified by the win_before_input_ path keyword resides on the source host. Before Windows targets y = Resides on the source host n = Resides on the target (default) win_before_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_before_prog_path keyword (only valid if you set the win_before_prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_before_prog_ path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 73

90 Keywords Keyword Description Related to Valid Values win_before_prog_ from_src Indicates whether the programs specified by the win_before_prog_path keyword resides on the source host. Before Windows targets y = Resides on the source host n = Resides on the target (default) win_before_prog_ path Specifies the full path of programs to be run on a Windows target before the file package is distributed to that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Before Windows targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. win_before_skip_ non_zero Indicates whether the distribution to the Windows target should be skipped (not performed) if the program specified by the win_before_prog_path keyword exits with a nonzero exit code. Before Windows targets y = Skip n = Do not skip (default) win_commit_input_ from_src Indicates whether the files specified by the win_commit_input_ path keyword resides on the source host. Commit Windows targets y = Resides on the source host n = Resides on the target (default) 1 74 Version 3.6

91 Keyword Description Related to Valid Values win_commit_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_commit_prog_ path keyword (only valid if you set the win_commit_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit Windows targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_commit_prog_ path keyword. The default is no path name. File Package Definitions win_commit_option Indicates whether to reboot the target after the commit operation completes, restart Windows on the target after the commit operation completes, or neither. If the commit program fails, a reboot or restart will not be performed. Commit Windows targets reboot = Reboot the target after the program runs restart = Restart Windows after the program runs NULL = Do not reboot, or restart Windows (default) win_commit_prog_ from_src Indicates whether the win_commit_prog_ path resides on the source host. Commit Windows targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 75

92 Keywords Keyword Description Related to Valid Values win_commit_prog_ path Specifies the full path of programs to be run on each Windows target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit Windows targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. win_on_error_ input_from_src Specifies whether the files specified by the win_on_error_input_ path keyword resides on the source host. On error Windows targets y = Resides on the source host n = Resides on the target (default) win_on_error_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_on_error_prog_ path keyword (only valid if you set the win_on_error_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_on_error_ prog_path keyword. The default is no path name Version 3.6

93 Keyword Description Related to Valid Values win_on_error_ option Indicates whether to reboot the target after the program runs, restart Windows on the target after the program runs, or neither. If the on error program fails, the target is not rebooted or restarted. On error Windows targets Keywords reboot = Reboot the target after the program runs restart = Restart Windows after the program runs NULL = Do not reboot, or restart Windows (default) File Package Definitions win_on_error_ prog_from_src Specifies whether the programs specified by the win_on_error_prog_ path keyword resides on the source host. On error Windows targets y = Resides on the source host n = Resides on the target (default) win_on_error_ prog_path Specifies a full path of programs to be run on a Windows target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error Windows targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. TME 10 Software Distribution Reference Manual 1 77

94 Keywords Keyword Description Related to Valid Values win_optional_dist Indicates whether the distribution is optional or mandatory. If the distribution is optional, the user at the target gets a pop-up dialog at distribution or removal time. From this dialog, the user can choose whether to have the file package distributed to or removed from his or her machine. If the distribution is mandatory, no such dialog is presented to the user the file package is automatically distributed or removed. If the user does not respond within the time specified in win_optional_dist_ timeout, the distribution or removal takes place. Optional distribu- tions to Windows targets y= Provides a dialog at distribution or removal time on the target in which the user can choose whether to have the file package distributed to or removed from his or her machine n = Automatically distributes or removes the file package with no option to override provided to the user at the target (default) win_optional_dist_ timeout Indicates the time in seconds that the optional distribution dialog is displayed on the target. If the user does not respond within the specified time period, the distribution or removal occurs. This is only valid if win_optional_dist is set to y. Optional distribu- tions to Windows targets Any integer in the range 1 through The default is Version 3.6

95 Keyword Description Related to Valid Values win_platform_ prefix Specifies a destination path for PCs running Windows. Destination paths on Windows targets Keywords A path that is added to the beginning of each destination path (as specified by default_dest) on Windows targets. There is no default value. File Package Definitions win_removal_input_ from_src Indicates whether the files specified by the win_removal_input_ path keyword resides on the source host. Removal Windows targets y = Resides on the source host n = Resides on the target (default) win_removal_input_ path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win_removal_prog_ path keyword (only valid if you set the win_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Removal Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win_removal_prog_ path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 79

96 Keywords Keyword Description Related to Valid Values win_removal_option Indicates whether to reboot the target after the removal, restart Windows on the target after removal, or neither. If the removal program fails, a reboot or restart will not be performed. Removal Windows targets reboot = Reboot the target after the program runs restart = Restart Windows after the program runs NULL = Do not reboot, or restart Windows (default) win_removal_prog_ from_src Indicates whether the programs specified by the win_removal_prog_ path keyword resides on the source host. Removal Windows targets y = Resides on the source host n = Resides on the target (default) win_removal_prog_ path Specifies the full path of programs to be run on the Windows target before removing a file package from that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal Windows targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. win95_after_input_ from_src Indicates whether the files specified by the win95_after_input_ path keyword resides on the source host. After Windows 95 targets y = Resides on the source host n = Resides on the target (default) 1 80 Version 3.6

97 Keyword Description Related to Valid Values win95_after_input_ path Specifies a full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_after_prog_ path keyword (only valid if you set the win95_after_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After Windows 95 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_after_prog_ path keyword. The default is no path name. File Package Definitions win95_after_option Indicates whether to reboot the target after the program runs, restart Windows 95 on the target after the program runs, or neither. If the after program fails, a reboot or restart will not be performed. After Windows 95 targets reboot = Reboot the target after the program runs restart = Restart Windows 95 after the program runs NULL = Do not reboot, or restart Windows 95 (default) win95_after_prog_ from_src Indicates whether the programs specified by the win95_after_prog_ path keyword resides on the source host. After Windows 95 targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 81

98 Keywords Keyword Description Related to Valid Values win95_after_prog_ path Specifies the full path of programs to be run on each Windows 95 target after a file package s files are applied to that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. win95_after_ removal_input_ from_src Specifies whether the files specified by the win95_after_removal_ input_path keyword resides on the source host. After removal Windows 95 targets y = Resides on the source host n = Resides on the target (default) 1 82 Version 3.6

99 Keyword Description Related to Valid Values win95_after_ removal_input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_after_removal_ prog_path keyword (only valid if you set the win95_after_removal_ prog_path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. After removal Windows 95 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_after_ removal_prog_path keyword. The default is no path name. File Package Definitions win95_after_ removal_option Indicates whether to reboot the target after the program runs, restart Windows 95 on the target after the program runs, or neither. If the after removal program fails, the target is not rebooted or restarted. Afte removal Windows 95 targets reboot = Reboot the target after the program runs restart = Restart Windows 95 after the program runs NULL = Do not reboot, or restart Windows 95 (default) win95_after_ removal_prog_ from_src Specifies whether the programs specified by the win95_after_removal_ prog_path keyword resides on the source host. After removal Windows 95 targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 83

100 Keywords Keyword Description Related to Valid Values win95_after_ removal_prog_path Specifies a full path of programs to be run on a Windows 95 target after removing a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. After removal Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. win95_before_ input_from_src Indicates whether the files specified by the win95_before_input_ path keyword resides on the source host. Before Windows 95 targets y = Resides on the source host n = Resides on the target (default) win95_before_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_before_prog_ path keyword (only valid if you set the win95_before_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Before Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_before_ prog_path keyword. The default is no path name Version 3.6

101 Keyword Description Related to Valid Values win95_before_prog_ from_src win95_before_prog_ path Indicates whether the programs specified by the win95_before_prog_ path keyword resides on the source host. Specifies the full path of programs to be run on a Windows 95 target before the file package is distributed to that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Before Windows 95 targets Before Windows 95 targets y = Resides on the source host n = Resides on the target (default) Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions win95_before_skip_ non_zero Indicates whether the distribution to the Windows 95 target should be skipped (not performed) if programs specified by the win95_before_prog_ path keyword exits with a nonzero exit code. Before Windows 95 targets y = Skip n = Do not skip (default) win95_commit_ input_from_src Indicates whether the files specified by the win95_commit_input_ path keyword resides on the source host. Commit Windows 95 targets y = Resides on the source host n = Resides on the target (default) TME 10 Software Distribution Reference Manual 1 85

102 Keywords Keyword Description Related to Valid Values win95_commit_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_commit_prog_ path keyword (only valid if you set the win95_commit_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Commit Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_commit_ prog_path keyword. The default is no path name. win95_commit_ option Indicates whether to reboot the target after the commit operation completes, restart Windows 95 on the target after the commit operation completes, or neither. If the commit program fails, a reboot or restart will not be performed. Commit Windows 95 targets reboot = Reboot the target after the program runs restart = Restart Windows 95 after the program runs NULL = Do not reboot, or restart Windows 95 (default) win95_commit_ prog_from_src Indicates whether the programs specified by the win95_commit_prog_ path keyword resides on the source host. Commit Windows 95 targets y = Resides on the source host n = Resides on the target (default) 1 86 Version 3.6

103 Keyword Description Related to Valid Values win95_commit_ prog_path Specifies the full path of programs to be run on a Windows 95 target during a file package commit operation. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Commit Windows 95 targets Keywords One or more valid, complete file names, separated by commas (no spaces). The default is no path name. File Package Definitions win95_on_error_ input_from_src Specifies whether the files specified by the win_on_error_input_ path keyword resides on the source host. On error Windows targets y = Resides on the source host n = Resides on the target (default) win95_on_error_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_on_error_ prog_ path keyword (only valid if you set the win95_on_error_ prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. On error Windows targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_on_error_ prog_path keyword. The default is no path name. TME 10 Software Distribution Reference Manual 1 87

104 Keywords Keyword Description Related to Valid Values win95_on_error_ option Indicates whether to reboot the target after the program runs, restart Windows 95 on the target after the program runs, or neither. If the on error program fails, the target is not rebooted or restarted. On error Windows 95 targets reboot = Reboot the target after the program runs restart = Restart Windows 95 after the program runs NULL = Do not reboot, or restart Windows 95 (default) win95_on_error_ prog_from_src Specifies whether the programs specified by the win95_on_error_ prog_ path keyword resides on the source host. On error Windows 95 targets y = Resides on the source host n = Resides on the target (default) win95_on_error_ prog_path Specifies a full path of programs to be run on a Windows 95 target if an error stops the distribution of a file package. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. On error Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name Version 3.6

105 Keyword Description Related to Valid Values win95_optional_dist Indicates whether the distribution is optional or mandatory. If the distribution is optional, the user at the target gets a pop-up dialog at distribution or removal time. From this dialog, the user can choose whether to have the file package distributed to or removed from his or her machine. If the distribution is mandatory, no such dialog is presented to the user the file package is automatically distributed or removed. If the user does not respond within the time specified in win95_optional_dist_ timeout, the distribution or removal takes place. Optional distribu- tions to Windows 95 targets Keywords y= Provides a dialog at distribution or removal time on the target in which the user can choose whether to have the file package distributed to or removed from his or her machine n = Automatically distributes or removes the file package with no option to override provided to the user at the target (default) File Package Definitions win95_optional_ dist_timeout Indicates the time in seconds that the optional distribution dialog is displayed on the target. If the user does not respond within the specified time period, the distribution or removal occurs. This is only valid if win95_optional_dist is set to y. Optional distribu- tions to Windows 95 targets Any integer in the range 1 through The default is 120. TME 10 Software Distribution Reference Manual 1 89

106 Keywords Keyword Description Related to Valid Values win95_platform_ prefix Specifies a destination path for PCs running Windows 95. Destination paths on Windows 95 targets A path that is added to the beginning of each destination path (as specified by default_dest) on Windows 95 targets. There is no default value. win95_removal_ input_from_src Indicates whether the files specified by the win95_removal_ input_ path keyword resides on the source host. Removal Windows 95 targets y = Resides on the source host n = Resides on the target (default) win95_removal_ input_path Specifies the full path of files to be passed as the second argument (argv[2] or %2) to the programs specified by the win95_removal_prog_ path keyword (only valid if you set the win95_removal_prog_ path keyword). If the input files reside on the source host, you can specify a relative path to them. Software Distribution obtains the input files from the path specified by the src_relpath keyword. Removal Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The order of these input files corresponds directly with the order of the programs specified by the win95_removal_ prog_path keyword. The default is no path name Version 3.6

107 Keyword Description Related to Valid Values win95_removal_ option Indicates whether to reboot the target after the removal, restart Windows 95 on the target after removal, or neither. If the removal program fails, a reboot or restart will not be performed. Removal Windows 95 targets Keywords reboot = Reboot the target after the program runs restart = Restart Windows 95 after the program runs NULL = Do not reboot, or restart Windows 95 (default) File Package Definitions win95_removal_ prog_from_src Indicates whether the programs specified by the win95_removal_prog_ path keyword resides on the source host. Removal Windows 95 targets y = Resides on the source host n = Resides on the target (default) win95_removal_ prog_path Specifies the full path of programs to be run on a Windows 95 target before removing a file package from that target. If the programs reside on the source host, you can specify a relative path to them. Software Distribution runs the programs from the path specified by the src_relpath keyword. Removal Windows 95 targets One or more valid, complete file names, separated by commas (no spaces). The default is no path name. a..ncf files are supported as NetWare configuration programs, however, they are executed asynchronously to the file package. If an.ncf configuration program starts successfully, it notifies the agent and the file package distribution begins. The distribution continues regardless of the.ncf program s completion status. b. User and group symbolic names are mapped to numeric UIDs and GIDs according to user and group definitions on the source host. If you specify a symbolic UID or GID using the export/import capability, it is resolved on the source host. However, if you specify a symbolic UID or GID using the desktop, it is resolved to the numeric ID on the server. TME 10 Software Distribution Reference Manual 1 91

108 Keywords 1 92 Version 3.6

109 Keywords File Package Definitions TME 10 Software Distribution Reference Manual 1 93

110 Keywords 1 94 Version 3.6

111 2 2Commands TME 10 command line interface (CLI) commands enable you to perform system operations from a UNIX or PC command line instead of using the TME 10 desktop. Most TME 10 commands begin with a w and often vowels are omitted to shorten the name of a command. Commands are also developed using the w+verb+object syntax, which matches the way you might think of the action. For example, to import a file package definition, use the wimprtfp command. To distribute a file package, use the wdistfp command. Commands Using TME 10 Commands It is often necessary or convenient to invoke a TME 10 management application operation from the command line rather than from the desktop. For example: You do not have access to a desktop, for example if you are connected to the network via modem You want to group several operations in a shell script or batch file An operation is not available using the desktop You prefer to invoke a command from a shell TME 10 Software Distribution Reference Manual 2 1

112 Command Line Syntax Command Line Syntax The manual pages in this appendix use the following special characters to define the command syntax: [ ] Identify optional arguments. Arguments not enclosed in brackets are required.... Indicates that you can specify multiple values for the previous argument. Indicates mutually exclusive information. You can use the argument to the left of the separator or the argument to its right. You cannot use both arguments in a single use of the command. { } Delimits a set of mutually exclusive arguments when one of the arguments is required. If the arguments are optional, they are enclosed in square brackets ([ ]). For example: wdistfp {-a -n -s} {-b -c -d -p} fp_name [subscriber...] The ellipses (...) following the subscriber argument indicate that you can specify multiple subscribers. Also, you must specify one argument in each set of arguments delimited by the (logical or) and enclosed in { } (braces), and the fp_name argument. Another example is the wsetfpprgs command. wsetfpprgs {-t type -T type} [keyword_option...] fp_name In this example, the t type and T type arguments are mutually exclusive; you must use one or the other. The keyword_option argument is an optional argument and you can specify it more than once. The fp_name argument is required. Object References When you reference an object in a command, the reference is not an absolute object reference like those used in programming. Instead, the reference is the label you gave the object when it was created. For example, when you refer to the Engineering object in a command, this reference corresponds to the Engineering policy region. 2 2 Version 3.6

113 There are two different forms of names that can be used with commands: Registered names Object References Object paths TME 10 commands support both naming schemes. Sometimes, you will find it more convenient to use one form over the other. Registered Names The key concept behind the name registry is a registered name. A registered name is a resource instance that is registered with the name registry when it is created. Every resource has a name and is of some particular type. For example, a UNIX machine called pescado has a name pescado and is of type ManagedNode. An example of a registered name used as an argument for the wdistfp command is: The syntax for specifying a resource using a registered name where type is the resource type and name is the instance on which you wish to perform some operation. You must always specify the ampersand character (@) before a registered name. In the above example, the file package example_fp is distributed to the managed node pescado. Commands Object Paths Object paths provide another way for you to specify an object name. They are similar to paths in file systems and can be relative or absolute. An absolute path begins with a backslash character (/). A relative path begins with any character including the special path components for the current directory (./) and for the parent directory (../). Some examples of object paths used as arguments for the wcd and wdistfp commands are: wdistfp -a -d /Regions/Distr/Source/PS_docs \ /Regions/pescado-region/pescado wcd /Library/ManagedNode wdistfp -a -d /Library/FilePackage/PS_docs./pescado TME 10 Software Distribution Reference Manual 2 3

114 TME 10 Software Distribution Commands The syntax for specifying a resource using an object path is /Regions/ObjectPath/[type:]name, where ObjectPath is the path to the object, type is the resource type, and name is the particular instance on which you wish to perform some operation. Use the optional type specifier if the specified resource has the same name as another resource of a different type. In the above examples, the PS_docs file package is distributed to the managed node pescado. This file package resides in the Distr policy region and Source profile manager, as indicated by the object path after /Regions. You can also specify the file package and managed node in terms of their class library (/Library), as illustrated by the second and third examples. TME 10 Software Distribution Commands The following table lists the TME 10 Software Distribution commands that you can run from the command line of a managed node: Command wcpfpblock wcrtfpblock wdistfp wdistfpblock wexprtfp wgetfpattr wimprtfp winstruct_file wmvapobj Purpose Copies a file package block from an existing file package block to the specified targets. Creates a file package block from an existing file package definition on the specified target. Distributes, commits, or previews a file package. Distributes the files in a file package block to the specified targets. Exports a file package definition. Gets the attributes for a file package. Imports a file package definition. Provides TME 10 Software Distribution with information necessary to install and manage an application. Moves AutoPacks from the lost-n-found collection to a profile manager. 2 4 Version 3.6

115 TME 10 Software Distribution Commands Command wmvfpobj wrmfp wrmfpblock wsetfpattr Purpose Moves a file package from the lost-n-found collection to a profile manager. Removes the files in a file package definition from a target. Removes the files in a file package block from the specified targets. Sets the attributes for a file package. wsetfpcontents wsetfpopts wsetfpprgs Sets the source host, file list, nested file package list, or exclude file list for a file package. Sets or modifies the options for a file package. Sets or modifies the configuration program information associated with a file package. Commands wswdistrim Sets the tracking feature to control when Software Distribution information is updated in the TME 10 Inventory configuration repository. The following table lists the PC agent commands: Command waddicon waddpath wclrblk wclrline wcpyfile Purpose Adds an icon to a Windows Program Manager group. (win, win95, nt) Adds an entry to the path statement on a Windows NT machine. (nt) Removes a block of statements from a file. (all supported PC platforms) Removes a single line from a file. (all supported PC platforms) Copies a file to the specified target volume and file. (nw) TME 10 Software Distribution Reference Manual 2 5

116 TME 10 Software Distribution Commands Command wdskspc weditini wgetkey wgetval winsblk winsline wmrgini wrestart wrplblk wrplline wrunprog wseterr wsettrus wsetval Purpose Verifies the amount of disk space available. (win, win95, nt, nw) Manipulates the groups, variables and values in an.ini file. (all supported PC platforms) Retrieves the subkey listing in a registry hive. (win95, nt) Retrieves a registry subkey. (win95, nt) Inserts a block of statements into a file. (all supported PC platforms) Inserts a single line into a file. (all supported PC platforms) Merges groups and variables from one.ini file into another. (all supported PC platforms) Initiates a system restart and optional reboot. (win95, nt) Replaces a block of statements in a file. (all supported PC platforms) Replaces a single line in a file. (all supported PC platforms) Runs a Windows program from a DOS batch file. (win) Sets the return code from a batch file for a configuration program. (all supported PC platforms) Assigns trustee rights to directories or files. (nw) Sets a registry key value. (win95, nt) 2 6 Version 3.6

117 NetWare Managed Site Commands NetWare Managed Site Commands The following table lists the commands available for setting and editing properties of NetWare managed sites, for monitoring and setting clients of TME 10 NetWare repeaters (TNWRs), and for dealing with files on the client of a NetWare managed site. These commands are fully documented in the TME 10 Framework Reference Manual. Command waddclnt Purpose Adds a client to the TNWRs list of available clients. (invoke from a NetWare server) wcrtnwms wdirnwc Creates a NetWare managed site. (invoke from a TMR server) Lists the contents of a directory on a client of a NetWare manage site. (invoke from a TMR server) Commands wexecnwc wgetnwcfile wgetnwms wlstclnt wpolclnt wputnwcfile wrmvclnt wsetnwms Executes a program on a client of a NetWare managed site. (invoke from a TMR server) Copies a file from a client of a NetWare managed site to the TME server. (invoke from a TMR server) Retrieves properties of a NetWare managed site. (invoke from a TMR server) Lists all available clients of a TNWR. (invoke from a NetWare server) Polls a client of a TNWR (to verify that its agent is running) and edits the client s TMEAGENT.CFG file. (invoke from a NetWare server) Copies a file from the TMR server to the client a NetWare managed site. (invoke from a TMR server) Removes a client from a TNWR s list of available clients. (invoke from a NetWare server) Sets properties of a NetWare managed site. (invoke from a TMR server) TME 10 Software Distribution Reference Manual 2 7

118 Command Syntax Command Syntax This section lists TME 10 Software Distribution commands, with syntax and descriptions of their functions. You can access these listings by using the man command on UNIX managed nodes or by using the on-line help file provided for NT managed nodes. 2 8 Version 3.6

119 waddicon NAME PURPOSE SYNOPSIS waddicon Adds an icon to a Windows Program Manager group. (Windows, Windows 95, Windows NT only) waddicon g group_name [ c command_line ] [ i icon_file] [ t icon_title] [ r] [ m message ] [ a] DESCRIPTION The waddicon command adds a new icon to a Windows, Windows 95, or Windows NT Program Manager group. If the group does not exist, it is created. If waddicon is launched as a batch from the NT service agent, the created program group will be a common program group. If waddicon is launched from the NT console agent, the created program group will be a user program group. Note: Tivoli recommends that PC agents be run as NT service agents, not as console agents. Arguments a Enables you to use this command asynchronously, such as in a batch file that is distributed to a PC where a user is not logged in. The command is actually executed when a user logs into the PC. You must use the command in a batch file if you specify this argument. This argument is supported on Windows NT only. c command_line Specifies the command line invoked by the icon. g group_name Specifies the program group name to which the icon is added. i icon_file Specifies the file containing the icon. If this argument is not specified, the Program Manager looks in the executable file specified by the -c argument. Commands TME 10 Software Distribution Reference Manual 2 9

120 waddicon m message Specifies a message to be written to the WADDICON.ERR file if an error occurs when using this command with the -a argument. The WADDICON.ERR file is created in the current working directory of the PC agent. This argument is supported on Windows NT only. r Removes the specified icon. If no icon is specified, attempts to remove the entire program group. t icon_title Specifies the title (description) below the icon in the Program Manager. RETURNS waddicon returns one of the following: 0 Indicates the successful addition of the icon. non-zero Indicates that waddicon was unsuccessful at adding the icon. EXAMPLES The following command example adds an icon called Word Processor for the word processor application to a Program Manager group called Applications. waddicon -g Applications -c \WP\WPROCESS.EXE \ -t Word Processor To remove the Word Processor icon from the Applications group, enter the following command: waddicon -g Applications -c \WP\WPROCESS.EXE \ -t Word Processor -r To remove the Applications group, enter the following command: waddicon -g Applications -r To add an icon to a user s desktop (on a Windows NT machine), include the following command in a batch file and distribute the file to 2 10 Version 3.6

121 the user s PC. If an error occurs, the message following the -m argument is written to the WADDICON.ERR file. C:\TIVOLI\TMEAGENT\WIN32\CLI\WADDICON \ -c C:\FILES\MY_PROG.EXE -t My Program \ -m Call #1 of waddicon -a waddicon Commands TME 10 Software Distribution Reference Manual 2 11

122 waddpath NAME PURPOSE SYNOPSIS waddpath Adds an entry to the path statement in the registry hive of the current control set. (Windows NT only) waddpath path_value DESCRIPTION The waddpath command adds an entry to Windows NT \System\CurrentControlSet\control\SessionManager\Environment key path in the HKEY_LOCAL_MACHINE registry hive. Once you add the entry, other applications will have a search path to the application. This command returns a message indicating if it successfully completed or encountered an error. Authorization administrator Arguments path_value Specifies the path entry to add to the registry hive in the current control set. EXAMPLE To add the \APPS\MISC\EXEC directory path to the registry hive, enter the following command: waddpath \APPS\MISC\EXEC 2 12 Version 3.6

123 wclrblk NAME PURPOSE SYNOPSIS wclrblk Removes a block of statements from a file. (All supported PC platforms) wclrblk [ r] s start_string e end_string [ o output_file] filename DESCRIPTION The wclrblk command removes a block of commands from a file. This command is intended to remove a block of commands clearly delimited at the beginning and end of blocks (such as a block added using winsblk or wrplblk). The caller must insert the delimiting lines along with the actual block of statements. Arguments e end_string Specifies a string to search for in the file that signifies the end of the block of statements. You must surround the string with double quotation marks. o output_file Specifies the name of the file that will receive the processed file. If this parameter is not specified, output is written to standard output. You cannot redirect the processed file to the file that you are modifying. r Removes the delimiter lines in addition to the block of statements. s start_string Specifies a string to search for in the file that signifies the start of the block of statements. You must surround the string with double quotation marks. filename Specifies the file from which the block should be removed. Commands TME 10 Software Distribution Reference Manual 2 13

124 wclrblk RETURNS EXAMPLE wclrblk returns one of the following: 0 Indicates that wclrblk successfully removed the specified block of statements. non-zero Indicates that wclrblk did not successfully remove the specified block of statements. To remove delimiter lines and the block of statements starting with [keyboard] and ending with type=4 from the SYSTEM.INI file, enter the following command: wclrblk -r -s [keyboard] -e type=4 \ -o C:\TEMP\OUTPUT.FIL C:\WINDOWS\SYSTEM.INI The output is written to the OUTPUT.FIL file, as specified by the -o argument. SEE ALSO winsblk, wrplblk 2 14 Version 3.6

125 wclrline NAME PURPOSE SYNOPSIS wclrline Removes a single line from a file. (All supported PC platforms) wclrline [ f] s search_string [ o output_file] filename DESCRIPTION The wclrline command removes a line from a text file, as specified by the search string. By default, output from this command is written to standard output. Arguments f Processes only the first occurrence of the search string. If this argument is not specified, all lines containing the search string are removed. o output_file Specifies the name of the file that will receive the processed file. If this parameter is not specified, output is written to standard output. s search_string Specifies a string to search for in the file. If the search string is contained in a line, the line is removed from the file. You must surround the string with double quotation marks. filename Specifies the name of the file from which to read. Commands RETURNS wclrline returns one of the following: 0 Indicates that wclrline successfully removed the specified line. non-zero Indicates that wclrline did not successfully remove the specified line. TME 10 Software Distribution Reference Manual 2 15

126 wclrline EXAMPLES To remove the first occurrence of a line starting with [boot] from the SYSTEM.INI file, enter the following command: wclrline -f -s [boot] -o C:\TEMP\OUTPUT.FIL \ C:\WINDOWS\SYSTEM.INI To remove all lines that have device= in them from the MYAPP.INI file, enter: wclrline -s device= -o C:\TEMP\OUTPUT.FIL \ C:\WINDOWS\MYAPP.INI Both example commands write their output to the OUTPUT.FIL file. SEE ALSO winsline, wrplline 2 16 Version 3.6

127 wcpfpblock NAME PURPOSE SYNOPSIS wcpfpblock Copies a file package block from an existing file package block to the specified targets. wcpfpblock [managed_node:]fpblock_path new_fpblock_path target [target...] DESCRIPTION The wcpfpblock command copies the file package block fpblock_path located on the specified managed node or the local managed node to a file specified by new_fpblock_path on the specified targets. A target must be a valid managed node. Authorization senior or super Arguments managed_node: Specifies the managed node on which the original file package block resides. If this argument is omitted, the command assumes that the file resides on the local managed node. fpblock_path Specifies the path to the file package block. new_fpblock_path Specifies the path to the new file package block. target Specifies a managed node to which to copy the new file package block. Commands TME 10 Software Distribution Reference Manual 2 17

128 wcpfpblock Return Codes EXAMPLES The wcpfpblock command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. To copy a file package block from the current system to the managed node grapevine, use the following command: wcpfpblock /tmp/example_fp.fpblock \ To copy a file package from the managed node grapevine to the managed node castle, use the following command: \ SEE ALSO wcrtfpblock, wdistfpblock, wrmfpblock 2 18 Version 3.6

129 wcpyfile NAME PURPOSE SYNOPSIS wcpyfile Enables an.ncf configuration program to copy a file. (NetWare only) wcpyfile s src_path d dest_path DESCRIPTION The wcpyfile command was created in support of.ncf configuration programs. It enables you to copy files from one volume or directory to another on the NetWare machine from within an.ncf configuration program. Arguments d dest_path Specifies the full path to the destination file. s src_path Specifies the full path to the source file. Commands EXAMPLE From an.ncf configuration program, enter the following command in the program to copy the SYS:\TEMP\FILE.NLM file to the SYS:\SYSTEM\FILE.NLM file: wcpyfile -s SYS:\TEMP\FILE.NLM -d SYS:\SYSTEM\FILE.NLM TME 10 Software Distribution Reference Manual 2 19

130 wcrtfpblock NAME PURPOSE SYNOPSIS wcrtfpblock Creates a file package block from an existing file package definition on the specified target(s). wcrtfpblock { a s} fp_name fpblock_path target [target...] DESCRIPTION The wcrtfpblock command creates a file package block for the specified file package and writes it to a file on the specified targets. Targets must be valid managed nodes. Authorization admin, senior, or super Arguments a Creates a file package block file that contains all files in the file package definition. s Creates a file package block that contains only files having a modification time on the source host that is later than the last successful distribution. fp_name fpblock_path target Specifies the object path or registered name of the file package for which a file package block is created. Specifies the name of the file to which to write the file package block. Specifies the name of the managed node to which to write the file package block Version 3.6

131 Return Codes EXAMPLES wcrtfpblock The wcrtfpblock command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. To create a file package block (of all files in the example_fp file package) on the managed nodes grapevine and castle, enter: SEE ALSO wcrtfpblock wcpfpblock, wdistfpblock, wrmfpblock Commands TME 10 Software Distribution Reference Manual 2 21

132 wdistfp NAME PURPOSE SYNOPSIS wdistfp Distributes, commits, or previews a file package to a subscriber or a set of subscribers. wdistfp { a n s} [ u] { b c d p} fp_name [subscriber...] DESCRIPTION This command distributes the file package to the specified subscribers. If no subscribers are specified, the file package is distributed to all subscribers of the profile manager in which the file package resides. The wdistfp command also enables you to commit and preview a file package. Authorization admin, senior, or super Arguments a Distributes all files in the file package. b Performs distribute and commit operations on the specified subscribers (combines the -d and -c arguments). c Performs a commit operation on the specified subscribers. d Performs a distribute operation to the specified subscribers. n Distributes modified files (changes in modification time, size, permissions, and so on) in the file package from the source managed node to the target. p Specifies a preview operation only. A list of the files to be sent to each subscriber is sent to standard output. When previewing a distribution, there are several things to consider: 2 22 Version 3.6

133 wdistfp The output in this area will be similar to the following: Unix target directory prefix: /tmp/unix NetWare target directory prefix: SYS:/NETWARE Windows target directory prefix: D:/WINDOWS / Feb 28 15:13: /tmp/default_dest/data.db Thus, this destination of the data.db file at the UNIX target will be /tmp/unix/tmp/default_dest/data.db; at the NetWare target, SYS:/NETWARE/tmp/default_dest/data.db; and at the Windows target, D:/WINDOWS/tmp/default_dest/data.db. The file is distributed to /platform_prefix_dir/default_dest_dir directory (as specified by the xxx_platform_prefix and default_dest keywords). You cannot preview files or directories that will be included in the file package as a result of a configuration program. The preview operation does not execute these programs. If the contents of the file package depend on an operation in a configuration program, the preview operation will not accurately display the contents of the file package. For example, suppose you specify a before program that will mount a CD-ROM on which a file (to be distributed) resides, as follows: Commands #!/bin/sh mount /dev/cdrom /src exit 0 The files on the mounted file system are not displayed during a preview operation because this program is not executed. s Distributes all files in the file package on the source managed node that have a modification time later than the time of the last successful distribution. u Includes the file package size in the information distributed with the file package. This information is TME 10 Software Distribution Reference Manual 2 23

134 wdistfp fp_name subscriber Return Codes EXAMPLES used by the TME 10 UserLink daemon to display a progress bar on the subscriber when the user retrieves a file package. Specifies an object path or registered name of the file package. Specifies an object path or registered name for a managed node, PC managed node, or profile manager on which to perform the specified operation. The subscriber must be subscribed to the profile manager in which the file package resides (unless the lenient_distribution attribute is set using the wsetfpattr command). The wdistfp command exits with the following codes: 0 Successful distribution. 1 An error occurred (due to an exception from a method called during the distribution operation). 2 The distribution failed. To distribute all files in the file package to the subscribers of the profile manager in which the file package resides, enter: wdistfp -a To distribute and commit all files in the file package that have changed on the source host since the last successful distribute to one of the file package s subscribers (castle), enter: wdistfp To commit the file package on two of the file package s subscribers (castle and grapevine), enter: wdistfp @grapevine 2 24 Version 3.6

135 wdistfp To preview the distribution of files that show any changes to two of the file package s subscribers (castle and grapevine), enter: wdistfp @grapevine SEE ALSO wrmfp Commands TME 10 Software Distribution Reference Manual 2 25

136 wdistfpblock NAME PURPOSE SYNOPSIS wdistfpblock Distributes the files in a file package block to the specified targets. wdistfpblock [ o keyword=override_arg]... [managed_node:] fpblock_path target [target...] DESCRIPTION The wdistfpblock command distributes the files in a file package block to the specified targets. The file package options, files, and so on, are contained in the file package block file. You can also optionally override some of the file package keywords. See Chapter 1, File Package Definitions for descriptions and valid values of the file package keywords. Authorization senior or super Arguments o keyword=override_arg Changes the value of the specified keyword to the value specified by override_arg. You can override the following keywords: append_log log_file preproc backup_fmt log_host prog_env create_dirs mail_id 2 26 Version 3.6

137 wdistfpblock skip_older_src install_progs no_overwrite stop_on_error list_path post_notice In addition, you can override the platform-specific keywords except for those that specify files that reside on the source host (such as src_after_input_path and os2_before_prog_from_src). See Chapter 1, File Package Definitions for the values that you can set for each of these keywords. The keywords that you can override are processed when the fpblock is removed from the target. All other keywords are processed when the file package block is created; overrides for them will have no effect.you can override the following keywords for directories to be distributed if the directory does not exist at the target: default_dir_mode unix_default_file_uid unix_default_file_gid The keywords that you can override are processed when the fpblock is unpacked on the target. All other keywords are processed when the file package block is created; overrides for them will have no effect. managed_node Specifies the managed node on which the file package block resides. fpblock_path Specifies the path to the file package block file. target Specifies the name of the managed nodes, PC managed nodes, and profile managers to which to distribute the file package block file. Commands TME 10 Software Distribution Reference Manual 2 27

138 wdistfpblock Return Codes EXAMPLES The wdistfpblock command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. To distribute a file package block file that exists on the local managed node to a specific managed node (castle), enter: wdistfpblock To distribute a file package block that exists on another managed node (grape), but override the log_host keyword option (so that the log file is written to the managed node grape instead of the managed node specified within the file package itself), enter: wdistfpblock o SEE ALSO wcpfpblock, wcrtfpblock, wrmfpblock 2 28 Version 3.6

139 wdskspc NAME PURPOSE SYNOPSIS wdskspc Verifies the amount of disk space available. (Windows platforms and NetWare) wdskspc [ s required_size] filename DESCRIPTION The wdskspc returns the amount of available disk space on the volume where filename resides. If you specify the -s argument, the command sets the return code of the command to zero if the required disk space is available and non-zero if not available. Arguments s required_size Specifies the amount of disk space required. The required_size argument can have any of the following suffixes: k: kilobytes m: megabytes g: gigabytes If you omit this argument, wdskspc returns the amount of available disk space. filename Returns the amount of available disk space on the volume or disk where the specified directory or file name resides. Commands EXAMPLES To check the C drive for 10 MB of available disk space, enter: wdskspc -s 10m C:\ To check the total disk space available on the C drive, enter: TME 10 Software Distribution Reference Manual 2 29

140 wdskspc wdskspc C:\ To check the SYS volume for 20 MB of available disk space on a NetWare machine, enter: wdskspc -s 20m SYS: 2 30 Version 3.6

141 weditini NAME PURPOSE SYNOPSIS weditini Modifies the groups, variables, and values in a.ini file. (All supported PC platforms) weditini [ r] g section_name [ n variable_name] v value] filename DESCRIPTION Arguments The weditini command edits the contents of a.ini file. Using this command, you can add a variable and value to a section of the file, remove a variable or section, or replace the value of a specified variable. g section_name Specifies the name of the section in the.ini file to process. If you add a variable to a section that does not exist, the section is created and the variable is added. n variable_name Specifies the variable name to add, replace, or remove. r Removes the specified section or variable. v value Specifies the value to add or replace for the variable specified by the n argument. filename Specifies the full path of the file to edit. Commands RETURNS weditini returns one of the following: 0 Indicates that weditini successfully edited the.ini file. non-zero Indicates that weditini did not successfully edit the.ini file. TME 10 Software Distribution Reference Manual 2 31

142 weditini EXAMPLES To add the DefaultDirectory variable to the UserSettings section in the C:\WINDOWS\SYSTEM.INI file and set its value to C:\WORK, enter: weditini g UserSettings n DefaultDirectory v C:\WORK \ C:\WINDOWS\SYSTEM.INI To remove the group UserSettings from the C:\WINDOWS\SYSTEM.INI file, enter: weditini r g UserSettings C:\WINDOWS\SYSTEM.INI SEE ALSO wmrgini 2 32 Version 3.6

143 wexprtfp NAME PURPOSE SYNOPSIS wexprtfp Exports a file package definition. wexprtfp [[ a] f [managed_node:] filename] [ c] fp_name DESCRIPTION The wexprtfp command exports the file package definition to standard output or, optionally, to the specified file if you use the -f argument. If you import a partial file package definition (a file containing only a header, the section delimiters, and the keywords to be set), you must use the -c argument when exporting the file package to export all keywords. If you do not specify this argument, only the partial file package definition is exported. Authorization user, admin, senior, or super Arguments a Overwrites the file being exported, if it exists. c Exports a complete file package definition, not just those imported into the file package from a partial file package definition. f [managed_node:] filename Writes the file package definition to the file specified by [managed_node:] filename, instead of standard output. The filename argument must be an absolute path. If the file exists and you do not specify the a argument, Software Distribution returns an error. Of course, the file need not exist; Software Distribution will create it. fp_name Specifies an object path or registered name of the file package whose definition is output by this operation. Commands TME 10 Software Distribution Reference Manual 2 33

144 wexprtfp Return Codes The wexprtfp command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. EXAMPLES To export the file package definition to standard output, enter: To export the file package definition to the /tmp/fp_desc.ascii file on the managed node castle, where that file already exists, enter: wexprtfp SEE ALSO wimprtfp 2 34 Version 3.6

145 wgetfpattr NAME PURPOSE SYNOPSIS wgetfpattr Gets the attributes for a file package. wgetfpattr { b d h I l m n p s S t w} fp_name DESCRIPTION The wgetfpattr command gets the attributes for a file package. All arguments to the command are mutually exclusive. Authorization user, admin, senior, or super Arguments b Gets the behavior_flags attribute. Possible values include: rm_host Moves the file package to the lost-n-found directory if the file package s log host or source host is removed. rm_fp Moves the file package to the lost-n-found directory if any of its nested file packages are removed. program_input Sets the xxx_program_input_from_src keywords to the same value as the xxx_program_prog_from_src keywords if the xxx_program_prog_from_src keywords are changed in the GUI. rm_no_chk Does not check to determine if a removed Commands TME 10 Software Distribution Reference Manual 2 35

146 wgetfpattr file package was nested in the file package. nm_chg_no_chk If the file package name is changed, does not check this file package to determine if it is nested. If this value is set, other file packages are checked, and if this file package is nested, the reference is changed to the new file package name. d value Sets the destination_flags attribute. Software Distribution checks this flag when you save a file package or import a file package definition from the desktop, or when you use the wimprtfp, wsetfpopts, or wsetfpcontents command. Possible values: nt Ensures that a destination is set for Windows NT platforms. nw Ensure that a destination is set for NetWare platforms. os2 Ensures that a destination is set for OS/2 platforms. unix Ensures that a destination is set for UNIX platforms. win Ensures that a destination is set for Windows platforms. win95 Ensures that a destination is set for Windows 95 platforms. any Ensures that a destination is set for at least one platform type. none Does not check destinations. If the destination_flags attribute is set for any of these, you must set the destination directory for the corresponding platform when setting the file package properties Version 3.6

147 wgetfpattr h Gets the src_host attribute. This is the object reference of the managed node (UNIX or Windows NT) that is the source host for the file package. If a source host is not defined for this file package, the value of this attribute is OBJECT_NIL. I Gets the fp_info attribute, which stores any optional information about the file package. Set optional information using the Edit Optional Information dialog from the Edit menu of the File Package Properties window. l Gets the lenient_distribution attribute. Possible values: TRUE Allows distributions and removals from the CLI to any managed node or profile manager, even if that managed node or profile manager is not currently a subscriber of the file package s profile manager (or any of its subscribing profile managers). FALSE Allows distributions and removals from the CLI only to managed nodes or profile managers that are currently subscribers to the file package s profile manager (or any of its subscribing profile managers). This is the default value. m Gets the default_push_mode attribute. This attribute specifies the mode of distribution that will be performed for a default distribution. A default distribution is performed when you select Distribute... from the profile manager icon or the profile manager menu, or when you drag and drop a file package icon onto a subscriber icon. all Distributes all files. src Distributes only files that have changed on the source managed node since the last successful distribution. Commands TME 10 Software Distribution Reference Manual 2 37

148 wgetfpattr any Distributes files that have changed on either the source or the target. n Gets the check_nested attribute. Values are: TRUE Checks to see if the file package contains circular nested file package references. FALSE Does not check for circular nested file package references. p Gets the push_time attribute. This attribute contains the time of the last successful distribute, distribute and commit, or commit operation (in seconds since 00:00:00 UTC, January 1, 1970). s Gets the check_no_src_host attribute. Values are: TRUE Ensures that a source host is specified for any file package properties set operation (for examples using the GUI, wsetfpcontents,orwimprtfp) where files or directories are specified (that is, if the file package does not contain just nested file packages). FALSE Does not ensure that a source host was specified during file package properties set operations. S Gets the fp_size attribute, which stores the size of the file package (in bytes). This size includes files, directories, and nested file packages included in the file package. Calculate the size of a file package by selecting Calculate Size... the file package icon menu in the Profile Manager window. t Gets the default_push_type attribute. This attribute specifies the type of distribution that will be performed for a default distribution. A default distribution is performed when you select Distribute... from the profile manager icon or the profile manager menu, or when you drag and drop a file package icon onto a subscriber. Values are: 2 38 Version 3.6

149 wgetfpattr dist commit both Performs a distribute operation. Performs a commit operation. Performs both a distribute and commit operation. w staging_area Gets the stage_area attribute. This attribute specifies the full path to a directory on the source host where the snapshot of the file package will reside. This snapshot is created when you distribute a file package using the Distribute entries with ANY changes option. fp_name Specifies an object path or registered name of the file package whose attributes are output by this operation. Return Codes The wgetfpattr command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. Commands EXAMPLES To determine whether this file package may be distributed from the command line to any managed node, enter: wgetfpattr To determine whether the source host must be specified before any file lists can be specified, enter: wgetfpattr SEE ALSO wsetfpattr TME 10 Software Distribution Reference Manual 2 39

150 wgetkey NAME PURPOSE SYNOPSIS wgetkey Retrieves the subkey listing in a registry hive. (Windows 95 and Windows NT only) wgetkey registry_key_path [registry_hive] DESCRIPTION The wgetkey command retrieves the subkeys associated with the specified key path from the specified registry hive. The output of this command is returned to standard output (on the console). Authorization administrator Arguments registry_key_path Specifies a registry key name from which to retrieve the subkeys. registry_hive Specifies the registry hive from which to retrieve the subkeys. Valid hives are: HKEY_LOCAL_MACHINE HKEY_CLASSES_ROOT HKEY_CURRENT_USER HKEY_USERS If you do not specify this argument, the command retrieves the subkeys from HKEY_LOCAL_MACHINE registry hive Version 3.6

151 EXAMPLES To retrieve the subkeys from the HKEY_LOCAL_MACHINE registry hive under the SOFTWARE key path, enter the following command. This command outputs a list of subkeys. wgetkey SOFTWARE To retrieve the key values from the HKEY_CURRENT_USER registry hive under the USERS key path, enter the following command: wgetkey USERS HKEY_CURRENT_USER wgetkey Commands TME 10 Software Distribution Reference Manual 2 41

152 wgetval NAME PURPOSE SYNOPSIS wgetval Retrieves a registry subkey. (Windows 95 and Windows NT only) wgetval [ h registry_hive] k n value_name DESCRIPTION The wgetval retrieves a subkey from a registry. The output of this command is returned to standard output. Authorization administrator Arguments h registry_hive Specifies the registry hive from which to retrieve the subkey. Valid values are: HKEY_LOCAL_MACHINE (default) HKEY_CURRENT_USER HKEY_CLASSES_ROOT HKEY_USERS k Specifies the key or file from which the subkey is retrieved. n value_name Specifies the name of the value. EXAMPLE To retrieve the version number of the Novell drivers, enter the following command: wgetval -h HKEY_LOCAL_MACHINE -k SOFTWARE\NOVELL \ -n CurrentVersion 2 42 Version 3.6

153 wgetval SEE ALSO wsetval Commands TME 10 Software Distribution Reference Manual 2 43

154 wimprtfp NAME PURPOSE SYNOPSIS wimprtfp Imports a file package definition. wimprtfp [ f [managed_node:] filename] [ h src_host] fp_name DESCRIPTION The wimprtfp command imports the file package definition from standard input, or, optionally, from the specified file if you use the f argument. Authorization admin, senior, or super Arguments f [managed_node:] filename Obtains the source for file package definition from the file specified by [managed_node:] filename, rather than from standard input. You must specify the absolute path of a file on the local or remote managed node. h src_host Sets the source host, where the files in the file package are obtained, to the host specified by src_host. fp_name Specifies an object path or registered name of the file package whose definition is set by this operation. Return Codes The wimprtfp command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error Version 3.6

155 wimprtfp EXAMPLES To import a file package definition on the local managed node, enter: wimprtfp -f To import the same file package definition (through standard input) and set the source host to crumpet, enter: < /tmp/fp_desc.ascii SEE ALSO wexprtfp Commands TME 10 Software Distribution Reference Manual 2 45

156 winsblk NAME PURPOSE SYNOPSIS winsblk Inserts a block of statements into a file. (All supported PC platforms) winsblk s search_string { a { b [ o output_file] filename DESCRIPTION Arguments The winsblk command inserts a block of statements into a file. This command enables you to add a block of statements delimited by unique strings, which you can later search for or remove using the wrplblk or wclrblk commands. a Inserts a block of statements after the line containing the search string. This parameter cannot be specified with the b argument. If you specify insertion_string, you must surround the string with double quotation marks. If you this command inserts the block of statements from the specified file. b Inserts a block of statements before the line containing the search string. This parameter cannot be specified with the a argument. If you specify insertion_string, you must surround the string with double quotation marks. If you this command inserts the block of statements from the specified file. o output_file Writes that output to the file specified by output_file. If this parameter is not specified, output is written to standard output Version 3.6

157 winsblk s search_string Specifies a search string. If the search string is contained in a line, the block of statements is placed either before (using the b argument) or after (using the a argument) the line containing the search string. If this argument is not specified, the block of statements is appended to the file. filename Specifies the input file. RETURNS EXAMPLE winsblk returns one of the following: 0 Indicates that winsblk successfully added the specified block of statements. non-zero Indicates that winsblk did not successfully add the specified block of statements. To insert the statements in the BLKSTMTS.FIL file after every occurrence of the device= string in the SYSTEM.INI file and redirect output to the OUTPUT.FIL file, enter the following command: Commands SEE ALSO winsblk -s device= \ -o C:\TEMP\OUTPUT.FIL C:\WINDOWS\SYSTEM.INI wrplblk, wclrblk TME 10 Software Distribution Reference Manual 2 47

158 winsline NAME PURPOSE SYNOPSIS winsline Inserts a single line into a file. (All supported PC platforms) winsline [ f] s search_string { a insertion_string b insertion_string } [ o output_file] filename DESCRIPTION The winsline command adds a line to a text file. You can insert the line before or after a line that contains the search string. Arguments a insertion_string Inserts the specified string or the lines contained in the specified file after the line that contained the search string. This parameter cannot be specified with the b argument. You must surround the string with double quotation marks. b insertion_string Inserts the specified string or the lines contained in the specified file before the line that contained the search string. This parameter cannot be specified with the a argument. You must surround the string with double quotation marks. f Processes only the first occurrence of the search string. If this argument is not specified, the command processes each occurrence of the search string. o output_file Specifies that output will be written to a file output_file. If this parameter is not specified, output is written to standard output. s search_string Specifies the search string. If the search string is contained in a line, the insertion string is placed either 2 48 Version 3.6

159 winsline filename before (using the b argument) or after (using the a argument) the line containing the search string. You must surround the string with double quotation marks. Specifies the name of the input file. RETURNS winsline returns one of the following: 0 Indicates that winsline successfully added the specified line. non-zero Indicates that winsline did not successfully add the specified line. EXAMPLES To insert lp01 after the first occurrence of the device= string in the SYSTEM.INI file and redirect output to the OUTPUT.FIL file, enter the following command: Commands winsline -f -s device= -a lp01 -o C:\TEMP\OUTPUT.FIL \ C:\WINDOWS\SYSTEM.INI To insert dev01 before every occurrence of the type= string in the SYSTEM.INI file, enter: winsline -s type= -b dev01 -o C:\TEMP\OUTPUT.FIL \ C:\WINDOWS\SYSTEM.INI The output from this command is redirected from standard output to the file OUTPUT.FIL. SEE ALSO wrplline, wclrline TME 10 Software Distribution Reference Manual 2 49

160 winstruct_file NAME PURPOSE SYNOPSIS winstruct_file Creates a TME 10 Software Distribution file package from information specified in an Application Management Package (AMP). winstruct_file a amp_file s staging_area [ t admin_tag] [ D variable=value]... DESCRIPTION Authorization The winstruct_file command, a subcommand of winstruct, extracts the contents of the application management package file (.amp) into a specified staging area. The subcommand reads the files (.aof,.gdf, and one or more.cdf) that are included in an Application Management Package (AMP) file. If necessary, winstruct_file creates the CCMS infrastructure that contains the policy region for the application. The subcommand also creates a profile manager and file package profile for each component containing a list of files to distribute. The winstruct_file subcommand ignores a repeated instruction, which permits the instruction process to continue for the remaining uninstructed tools. For example, suppose you execute the winstruct command set for an application, but the process does not complete for some reason. When you correct the problem and issue the command again, the instruction process continues from the point where it halted. You can execute this command directly winstruct_file can be invoked independently of the other winstruct subcommands or you can execute the winstruct command to invoke winstruct_file. See the TME 10 Framework Reference Manual for additional information about winstruct commands. senior or super 2 50 Version 3.6

161 winstruct_file Arguments EXAMPLE a amp_file Specifies the path and file name of an AMP. s staging_area Specifies a directory into which the winstruct_file command extracts the contents of the AMP. t admin_tag Specifies an administrator tag for the instruct action. Unique administrator tags enable the instructing of multiple versions of an AMP. D variable=value Specifies the name of a Management Tool Extension group variable and its value. You can specify multiple variables, but you must enter D for each variable and value pair. To instruct TME 10 Software Distribution with information for managing an application, enter all on one line: Commands winstruct_file -a /applications/amps/super_app.amp -s /install/staging -t rev1 -D comp_src_dir1=cdrom1 -D comp_src_dir2=/src/app/comp_files This command extracts the contents of the super_app AMP into the /install/staging directory and reads the.aof,.gdf, and.cdf description files. The instruction process is labeled with the rev1 tag. The tag distinguishes this version of the AMP from others. In this example, the application files are not included in the AMP, but are instead located on a CD-ROM disk, specified with the D argument. For each component in the AMP, the command checks the Management Tool Extension group (an AMS group) for variable=value pairs and command line arguments. This data determines the source directory (or directories) for the application files. Each component can refer to a different D argument, and different components can refer to the same argument. Enter as many D arguments as required, using a new D for each variable and value pair. SEE ALSO winstruct TME 10 Software Distribution Reference Manual 2 51

162 wmrgini NAME PURPOSE SYNOPSIS wmrgini Merges groups and variables from one.ini file into another. (All supported PC platforms) wmrgini dest_file merge_file DESCRIPTION Arguments The wmrgini command merges the contents of one.ini file in another. For each variable in merge_file, the command creates or replaces an identical variable in dest_file. dest_file merge_file Specifies the name of the destination file. Specifies the name of the file to merge. EXAMPLE To merge the SYSTEM.INI file into the WIN.INI file, enter the following: wmrgini C:\TEMP\WIN.INI C:\TEMP\SYSTEM.INI SEE ALSO weditini 2 52 Version 3.6

163 wmvapobj NAME PURPOSE SYNOPSIS wmvapobj Moves an AutoPack from the lost-n-found collection. wmvapobj ap_name [ap_name...] target_collection DESCRIPTION Arguments ap_name The wmvapobj command moves the specified AutoPack(s) from the lost-n-found collection to the specified collection. An AutoPack resides in the lost-n-found collection if its source host was removed from the TME 10 environment. You can specify multiple AutoPacks on the same command line. Specifies the AutoPack to be moved from lost-n-found. You can specify more than one AutoPack. Do not precede the name of the AutoPack target_collection Specifies the target collection. You can specify the name of a profile manager or policy region. Do not precede the name of the collection Commands EXAMPLE To move the Word6 and PSP AutoPacks from the lost-n-found collection to the Ready-to-distrib profile manager, enter the following command: wmvapobj Word6 PSP Ready-to-distrib TME 10 Software Distribution Reference Manual 2 53

164 wmvfpobj NAME PURPOSE SYNOPSIS wmvfpobj Moves a file package from the lost-n-found collection. wmvfpobj fp_name [fp_name...] target_collection DESCRIPTION Arguments ap_name The wmvfpobj command moves the specified file package(s) from the lost-n-found collection to the specified collection. A file package resides in the lost-n-found collection if its source host or parent file package was removed from the TME 10 environment. You can specify multiple file packages on the same command line. Specifies the file package to be moved from lost-n-found. You can specify more than one file package. Do not precede the name of the file package target_collection Specifies the target collection. You can specify the name of a profile manager or policy region. Do not precede the name of the collection EXAMPLE To move the Frame4 file package from the lost-n-found collection to the Marketing profile manager, enter the following command: wmvfpobj Frame4 Marketing 2 54 Version 3.6

165 wrestart NAME PURPOSE SYNOPSIS wrestart Initiates a system restart and optional reboot. (Windows NT only) wrestart [ c] [ b] [ t timeout_value] [ m confirm_message ] DESCRIPTION The wrestart command initiates an operating system restart and optional machine reboot. Arguments c Prompts the user for confirmation before restarting the system or rebooting. b Reboots the system after shutdown. m confirm_message Specifies the confirmation message that will be displayed. t timeout_value Specifies the number of seconds this command waits for user confirmation before initiating a restart. Commands EXAMPLES To prompt the user for confirmation before restarting the system, enter the following command: wrestart -c To display a warning message before restarting the system in 60 seconds, enter: wrestart -m WARNING: The system will reboot in 60 \ seconds!! -t 60 TME 10 Software Distribution Reference Manual 2 55

166 wrmfp NAME PURPOSE SYNOPSIS wrmfp Removes the files in a file package definition from a subscriber or set of subscribers. wrmfp [ d r] fp_name [subscriber...] DESCRIPTION Authorization Arguments Removes the file package from the specified subscriber or set of subscribers. If no subscribers are specified, the file package is removed from all subscribers of the profile manager in which the file package resides. The d and r arguments specify whether to remove empty directories at the target managed node. You can use these arguments to override the current value for the Remove Empty Directories option (the rm_empty_dirs keyword) in the file package definition. If neither of these arguments is specified, the command performs the operation specified by the Remove Empty Directories option in the file package definition. Note that the d and r arguments only override the rm_empty_dirs keyword in the parent file package. Removing the directories for nested file packages is always based on the value of the rm_empty_dirs keyword in that nested file package. admin, senior, or super d Does not remove the empty directories that are not explicitly specified in the file package from the target managed node. r Removes the empty directories that are not explicitly specified in the file package from the target managed node. Empty directories are deleted up to, but not 2 56 Version 3.6

167 wrmfp fp_name subscriber Return Codes including, the /xxx_platform_prefix/default_dir directory Specifies an object path or registered name of the file package. Specifies an object path or registered name for a managed node, PC managed node, or profile manager on which to perform the specified operation. The subscriber must be subscribed to the profile manager in which the file package resides (unless the lenient_distribution attribute is set using the wsetfpattr command). The wrmfp command exits with the following codes: 0 Successful removal. 1 An error occurred (due to an exception from a method called during the removal). 2 The removal failed. Commands EXAMPLES To remove the file package from all of the file package s subscribers, enter the following command: To remove the file package from one of the file package s subscribers (castle), and to force the removal of any empty directories not explicitly specified in the file package, enter: TME 10 Software Distribution Reference Manual 2 57

168 wrmfpblock NAME PURPOSE SYNOPSIS wrmfpblock Removes the files and directories distributed from a file package block. wrmfpblock [ o keyword=override_arg]... [managed_node:]fpblock_path target... DESCRIPTION The wrmfpblock command removes the files and directories in the distributed file package block from the specified targets. You can also optionally override some of the file package keywords. See Chapter 1, File Package Definitions for descriptions and valid values of the file package keywords. Authorization senior or super Arguments o keyword=override_arg Sets the specified keyword to the specified value. You can override the following keywords: append_log log_file preproc backup_fmt log_host prog_env create_dirs mail_id skip_older_src install_progs 2 58 Version 3.6

169 wrmfpblock no_overwrite stop_on_error list_path post_notice In addition, you can override the platform-specific keywords except for those that specify files that reside on the source host (such as src_after_input_path and os2_before_prog_from_src). See Chapter 1, File Package Definitions for the values that you can set for each of these keywords. The keywords that you can override are processed when the fpblock is removed from the target. All other keywords are processed when the file package block is created; overrides for them will have no effect. [managed_node:] fpblock_path Specifies the name of the managed node on which the file package block resides. You can specify managed_node: to specify the path to the file package block file from which the files and directories were distributed. target Specifies the name of the managed nodes, PC managed nodes, or profile managers from which to remove the distributed files and directories. Return Codes The wrmfpblock command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. Commands TME 10 Software Distribution Reference Manual 2 59

170 wrmfpblock EXAMPLE To remove the files in a file package block from the subscriber grape, enter the following command: wrmfpblock o log_host=grape /tmp/example_fp.fpblock SEE ALSO wcpfpblock, wcrtfpblock, wdistfpblock 2 60 Version 3.6

171 wrplblk NAME PURPOSE SYNOPSIS wrplblk Replaces a block of statements in a file. (All supported PC platforms) wrplblk [ r] s start_string e end_string [ o output_file] { i filename DESCRIPTION Arguments The wrplblk command replaces a block of commands in a file. This command is intended to replace a block of commands that are clearly delimited at the beginning and end of the block (such as those added using the winsblk command. e end_string Specifies a search string that signifies the end of the block of statements. You must surround the string with double quotation marks. i { Specifies a string to replace the text in between the delimited statements, or a file containing a block of statements. You must surround the string with double quotation marks. o output_file Writes the output of this command to the output_file file, instead of standard output. r Replaces the delimiter lines in addition to the block of statements. s start_string Specifies a search string that signifies the start of the block of statements. You must surround the string with double quotation marks. filename Specifies the input file. Commands TME 10 Software Distribution Reference Manual 2 61

172 wrplblk EXAMPLE To replace a block of statements beginning with [boot] and ending with end in the SYSTEM.INI file with statements in the RPLBLK.FIL file, enter the following command: wrplblk -s [boot] -e end -o C:\TEMP\OUTPUT.FIL \ C:\WINDOWS\SYSTEM.INI The output of this command is redirected to the OUTPUT.FIL file. SEE ALSO winsblk, wclrblk 2 62 Version 3.6

173 wrplline NAME PURPOSE SYNOPSIS wrplline Replaces a single line in a file. (All supported PC platforms) wrplline [ f] s search_string [ o output_file] r replace_string filename DESCRIPTION The wrplline command replaces a line in a text file. The line to be replaced is found using a search string. Output from this command is written to standard output. Arguments f Processes only the first occurrence of the search string. If this argument is not specified, the command processes each occurrence of the search string. o output_file Writes the output of this command to the output_file file, instead of standard output. r replace_string Specifies a string to replace the line that contained the search string. You must surround the string with double quotation marks. s search_string Specifies a search string. If the search string is contained in a line, the line is replaced with the string specified by the r argument. You must surround the string with double quotation marks. filename Specifies the name of the file in which to replace the line. Commands TME 10 Software Distribution Reference Manual 2 63

174 wrplline EXAMPLE To replace every occurrence of a line beginning with device= in the SYSTEM.INI file with the type= string, enter the following command: wrplline -s device= -o C:\TEMP\OUTPUT.FIL -r type= \ C:\WINDOWS\SYSTEM.INI The output of this command is written to the OUTPUT.FIL file. SEE ALSO wclrline, winsline 2 64 Version 3.6

175 wrunprog NAME PURPOSE SYNOPSIS wrunprog Runs a Windows program from a DOS batch file. (Windows only) wrunprog nl command_line DESCRIPTION Arguments nl The wrunprog command invokes a Windows program from a DOS batch file. Usually, you cannot run Windows programs from a DOS configuration batch program. The wrunprog command instructs the PC agent to run the specified command line from the Windows environment. When launched from the service agent, wrunprog runs with SYSTEM authorization. When launched from the console agent (diagnostic), wrunprog can launch only processes that the user has authorization to run. Note: Tivoli recommends that PC agents be run as NT service agents, not as console agents. Executes this command asynchronously; that is, it spawns the command then returns immediately. command_line Specifies the program (and arguments) to be invoked by the PC agent. Commands EXAMPLE To run the Notepad program, enter the following command: wrunprog C:\WINDOWS\NOTEPAD.EXE TME 10 Software Distribution Reference Manual 2 65

176 wseterr NAME PURPOSE SYNOPSIS wseterr Sets the return code from a batch file for a configuration program. (All supported PC platforms) wseterr return_code DESCRIPTION The wseterr command sets the return code for a batch file invoked as a configuration program. This return code is passed to the PC Agent which, in turn, determines the success or failure of the script. Tivoli recommends that you specify this command at the end of all batch files to return the proper code to Software Distribution. Arguments return_code Specifies the return code to be returned. EXAMPLE To pass the 1 return code to the PC agent, which returns the code to Software Distribution, enter the following command: wseterr Version 3.6

177 wsetfpattr NAME PURPOSE SYNOPSIS wsetfpattr Sets the attributes for a file package. wsetfpattr [ b value] [ d value] [ h src_host] [ I fp_info] [ l value] [ m dist_mode] [ n value] [ p push_time] [ s value] [ S fp_size] [ t dist_type] [ w staging_area] fp_name DESCRIPTION Authorization Arguments The wsetfpattr command sets the attributes for a file package. admin, senior or super b value Sets the behavior_flags attribute. Possible values are: rm_host Moves the file package to the lost-n-found collection, if the file package s log host or source host is removed. rm_fp Moves the file package to the lost-n-found collection if any of its nested file packages are removed. program_input Sets the xxx_program_input_from_src keyword to that same value as the xxx_program_prog_from_src keyword, if it was changed in the GUI. rm_no_chk Does not check to determine if a removed file package was nested in the file package. Commands TME 10 Software Distribution Reference Manual 2 67

178 wsetfpattr nm_chg_no_chk If the file package name is changed, does not check this file package to determine if it is nested. If this value is set, other file packages are checked, and if this file package is nested, the reference is changed to the new file package name. You can OR any of the previous values (for example, rm_no_chk nm_chg_no_chk). none Sets all of the values to FALSE. d value Sets the destination_flags attribute. Software Distribution checks this flag when you save a file package or import a file package definition from the desktop, or when you use the wimprtfp, wsetfpopts, or wsetfpcontents command. Possible values: nt Ensures that a destination is set for Windows NT platforms. nw Ensure that a destination is set for NetWare platforms. os2 Ensures that a destination is set for OS/2 platforms. unix Ensures that a destination is set for UNIX platforms. win Ensures that a destination is set for Windows platforms. win95 Ensures that a destination is set for Windows 95 platforms. You can OR any of the previous values (for example, nt win win95). any Ensures that a destination is set for at least one platform type. none Does not check destinations. You cannot OR any and none with other values Version 3.6

179 wsetfpattr h src_host Sets the src_host attribute. I Sets the fp_info attribute, which stores any optional information about the file package. This information is set from the desktop using the Edit Optional Information dialog from the Edit menu of the File Package Properties window. You must use double quotes if the fp_info string contains spaces. l value Sets the lenient_distribution attribute. Possible values: TRUE Allows distributions and removals from the CLI to any managed node or profile manager, even if that managed node or profile manager is not currently a subscriber of the file package s profile manager (or any of its subscribing profile managers). FALSE Allows distributions and removals from the CLI only to managed nodes or profile managers that are currently subscribers to the file package s profile manager (or any of its subscribing profile managers). m dist_mode Sets the default_push_mode attribute. This attribute specifies the mode of distribution that will be performed for a default distribution. A default distribution is performed when you select Distribute... from the profile manager icon or the profile manager menu, or when you drag and drop a file package icon onto a subscriber icon. You can specify one of the following modes: all Distribute all files. src Distribute only files that have changed on the source managed node. any Distribute files that have changed on either the source or the target. n value Sets the check_nested attribute. Values are: Commands TME 10 Software Distribution Reference Manual 2 69

180 wsetfpattr TRUE Checks for circular links for any file package properties set operation (using the GUI, the wsetfpcontents command, or the wimprtfp command), where nested file packages are modified. FALSE Does not check for circular links during file package properties set operations. p push_time Sets the push_time attribute. push_time contains the time of the last successful distribute, commit, or removal operation (in seconds since 00:00:00 UTC, January 1, 1970). s value Sets the check_no_src_host attribute. Values are: TRUE Ensures that a source host is specified for any file package properties set operation (for examples using the GUI, wsetfpcontents,orwimprtfp) where files or directories are specified (that is, if the file package does not contain just nested file packages). FALSE Does not check that a source host was specified during file package properties set operations. S Sets the fp_size attribute, which stores the size of the file package (in bytes). This size includes files, directories, and nested file packages included in the file package. Calculate the size of a file package from the desktop by selecting Calculate Size... the file package icon menu in the Profile Manager window. t dist_type Sets the default_push_type attribute. This attribute specifies the type of distribution that will be performed for a default distribution. A default distribution is performed when you select the Distribute... option from the profile manager icon or the profile manager menu, or when you drag and drop a file package icon onto a subscriber icon. Values are: 2 70 Version 3.6

181 wsetfpattr dist commit both Performs a distribution. Performs a commit operation. Performs both a distribute and commit operation. w staging_area Sets the stage_area attribute. This attribute specifies the full path to a directory on the source host where the snapshot of the file package will reside. This snapshot is created when you distribute a file package using the Distribute entries with ANY changes option. The staging_area argument must be a full path to a directory, not a file. fp_name Specifies an object path or registered name of the file package whose attributes are set by this operation. Return Codes The wsetfpattr command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. Commands EXAMPLES To specify that this file package may be distributed to or removed from any managed node from the command line, enter: wsetfpattr -l To specify that the source host does not need to be specified before specifying file lists, enter: wsetfpattr -s SEE ALSO wgetfpattr TME 10 Software Distribution Reference Manual 2 71

182 wsetfpcontents NAME PURPOSE SYNOPSIS wsetfpcontents Sets the source host, file list, nested file package list, or exclude file list for a file package. wsetfpcontents [ T] [ E [managed_node:]exclude_path] [ F [managed_node:] filelist_path] [ h src_host] [ N [managed_node:]nested_path] fp_name wsetfpcontents t [ E] [ F] [ h] [ N] fp_name DESCRIPTION The wsetfpcontents command manipulates the contents of an existing file package by setting the source host, file list, nested file package list, and exclude file list. If you specify the t argument, you must specify additional arguments alone (see the second synopsis statement). Authorization admin, senior, or super Arguments E [managed_node:]exclude_path Changes the exclude file list to those files and directories listed in the file specified by [managed_node:]exclude_path. F [managed_node:]filelist_path Changes the file list to those files and directories listed in the file specified by [managed_node:]filelist_path. See Files and Directories Section on page 1-3 for a list of valid entries for the file list. h src_host Changes the source host, where the files in the file package are obtained, to the managed node specified by src_host. This argument is optional unless you are adding source files or directories to the file package; in 2 72 Version 3.6

183 wsetfpcontents that case, you must specify a source host using this argument. N [managed_node:]nested_path Changes the nested file package list to those file packages listed in the file [managed_node:]nested_path. T Sets the file package list and source host without invoking the validation methods in the policy. The T option is set by default. t Sets the file package list and source host after invoking the validation methods in the policy defaults (if any are set) or TME 10 defaults. fp_name Specifies the object path or registered name of the file package to be modified. Return Codes The wsetfpcontents command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. Commands EXAMPLES To set the source host to crumpet, enter the following command: To set the exclude file list specified in the /tmp/exclude.list file, enter: wsetfpcontents -E To set the file list to the default defined by the fp_def_flist policy method, enter: wsetfpcontents -t SEE ALSO wsetfpopts, wsetfpprgs TME 10 Software Distribution Reference Manual 2 73

184 wsetfpopts NAME PURPOSE SYNOPSIS wsetfpopts Sets or modifies the options for a file package. wsetfpopts { T type t type} {keyword_options} fp_name DESCRIPTION Authorization Arguments The wsetfpopts command manipulates file package options by setting keyword options, either to a specified value or to their default. It cannot manipulate the contents of a file package (such as wsetfpcontents), nor the configuration program information associated with a file package (like wsetfpprgs). admin, senior or super keyword_options Sets the keyword values for the file package. If used with the t argument, the keyword is reset to its default value. If used with the T argument, the keyword is set to a user-specified value as indicated below. Valid values are as follows: path A fully-specified path for a file. y n YES or NO, respectively. string gid uid int path A command to be performed when appropriate for the specified keyword. The numeric group ID. The numeric user ID. An integer. A fully-specified path for a file or directory Version 3.6

185 wsetfpopts Pmode time mail_id log_host A file permission setting (see the chmod man page). A date value for the date and time (conforming to date semantics). An address for a user; for example: joe@work.com. Label of the managed node. fp_name Specifies an object path or registered name of the file package whose options are modified by this operation. t type Sets the specified keyword option to its default value. The type argument specifies the type of platform on which the keyword is set. Software Distribution looks for default settings in the file package s policy region first. If the default is not set there, Software Distribution adopts the program defaults as described in Chapter 1, File Package Definitions. Do not specify arguments with t type keyword options for example, -t unix -v does not require any arguments after the -v keyword option. Valid types are shown below, with their valid keyword options: gen unix nw All platforms; keyword options are not platform-specific (apply to all platforms). Valid keyword options for gen are: a, A, b, B, c, C, d, D, e, E, f, F, h, H, i, I, j, k, l, L, m, M, n, N o, P, q, Q, r, R, s, S, -v, and x. See below for keyword option descriptions. Keyword options that apply specifically to UNIX type target machines. Valid keyword options for unix are: g, G, p, u, and U. See below for keyword option descriptions. Keyword options that apply specifically to NetWare target machines. Valid keyword Commands TME 10 Software Distribution Reference Manual 2 75

186 wsetfpopts win win95 nt options for nw are p, V, X, y, Y, z, and Z. See below for keyword option descriptions. Keyword options that apply specifically to Windows target machines. Valid keyword options for win are: w, W and p. See below for keyword option descriptions. Keyword options that apply specifically to Windows 95 target machines. Valid keyword options for win95 are: w, W and p. See below for keyword option descriptions. Keyword options that apply specifically to Windows NT target machines. The valid keyword option for nt is p. See below for keyword option descriptions. os2 Keyword options that apply specifically to OS/2 target machines. The valid keyword option for os2 is p. See below for keyword option descriptions. T type Sets the specified keyword option to the specified argument. The type argument specifies the type of platform on which the keyword is set. Valid types are gen, unix, nw, win, win95, nt, and os2, as discussed above. General Keyword Options Use the general following keyword options with the T gen argument: a [y n] Sets the append_log keyword, which toggles whether to append a notice to a log file when an operation is performed (y) or to replace the previous notice (n). -A Sets the new keyword, ams_inst_sw_comp_handle, to denote the AMS Installed Software Component Handle, which identifies the installed software component handle created for the software component by the Tivoli Developer s Toolkit. Software 2 76 Version 3.6

187 wsetfpopts Distribution passes the value of this keyword as the third argument to before and after configuration programs. b string Sets the backup_fmt keyword, which specifies a backup path for files if they already exist at the target. For example, if you specify string to be /backup/%p/%f%n. %p provides the base path, %f provides the filename, and %n is an autoincrementing numeric value. Thus, if you specify /etc/motd as the backup file, the resulting file s path becomes /backup/etc/motd1. The next time the file is distributed, the resulting backup file is named /backup/etc/motd2, and so on. B uid Sets the log_file_uid keyword, which sets the UID of the log file specified by the log_file keyword. c [y n] Sets the do_compress keyword, which toggles whether to compress the file package before distributing it (y) or not (n). C [y n] Sets the create_dirs keyword. This keyword toggles whether to create intermediate directories at the destination for the files in a file package if those directories do not exist (y) or not (n). d [y n] Sets the descend_dirs keyword, which toggles whether to traverse component directories in the file package listing (y)ornot(n). If y, The directories and all files and directories therein are distributed. D path Sets the default_dest keyword, which specifies the default destination directory (entered as an absolute path) for all entries in the file package. e mail_id Sets the mail_id keyword, which is the complete address (such as joe@work.com) of person(s) to whom to send mail. For multiple mail recipients, separate addresses by a single space and enclose the collection of addresses in double quotes. Commands TME 10 Software Distribution Reference Manual 2 77

188 wsetfpopts E string Sets the prog_env keyword, which specifies a string as the putenv value before a configuration program runs on a UNIX machine. The string argument is a list of name=value pairs where name is an environment variable set by value. Refer to Chapter 1, File Package Definitions for more information on the prog_env keyword. f [y n] Sets the follow_links keyword, which toggles whether to follow symbolic links to the original files (thereby copying the files to the target instead of the links) (y), or to create new links to the original files at the destination, and not distribute the files (n). F [y n] Sets the file_cksums keyword, which toggles whether to compute the checksum on individual files to detect differences between the source and target (y). h log_host Sets the log_host keyword, which specifies the label of the managed node where the log file is generated. H gid Sets the log_file_gid keyword, which sets the GID of the log file specified by the log_file keyword. i time Sets the default_mtime keyword, which specifies the default modification time (conforming to date semantics) for all entries distributed in the file package. I [y n] Sets the install_progs keyword, which toggles whether to remove the configuration the target machine after they run. If you specify y, the programs are not removed. j mode Sets the log_file_mode keyword, which sets the file mode of the log file specified by the log_file keyword. k [y n] Sets the keep_paths keyword, which toggles whether to concatenate the entire source file path into the destination file path (y). The default is n. l path Sets the list_path keyword, which specifies a directory on the target host where the list of distributed 2 78 Version 3.6

189 wsetfpopts files to that target are stored. The file is named fpname.log. L path Sets the log_file keyword, which appends notices to the specified complete path of a file if the a argument (the append_log keyword) is set to y, or replaces notices if set to n. The managed node for this file is specified by the h argument. If no host is specified, the TMR server is used. If the file does not exist, an attempt is made to create it. m mode Sets the default_file_mode keyword, which specifies the mode of files (according to chmod numeric specification) for files that are distributed. M mode Sets the default_dir_mode keyword, which specifies the mode of directories (according to chmod (2) numeric specification) for directories that are distributed. n [y n] Sets the no_overwrite keyword, which toggles to not overwrite files existing on the target with those in the file package (y). N [y n] Sets the nested_first keyword, which unpacks files within nested file packages first at the target (y). The default is to unpack them last (n). o [y n] Sets the skip_older_src keyword, which does not distribute source files in the file package if they are older than those on the target (y). P [y n] Sets the post_notice keyword, which toggles whether to post notices to the Software Distribution notice group when file package operations are performed (y). q string Sets the postproc keyword, which specifies a processing filter to be run before the file package is sent out from the host (but after it is packaged). Q string Sets the preproc keyword, which specifies a processing filter to be run before the distribution is unpacked at the target. Commands TME 10 Software Distribution Reference Manual 2 79

190 wsetfpopts r [y n] Sets the rm_empty_dirs keyword, which toggles whether to remove all empty target directories, up to /xxx_platform_prefix/default_dest at the target after the file package is removed (y) or not (n). The default is n. R [y n] Sets the rm_extraneous keyword, which toggles whether to remove files in an existing destination directory that are extraneous to the file package (y)or not (n) during a distribution (of all file package entries). The default is n. If the b argument (the backup_fmt keyword) is used, the removed files are first copied to a backup directory. s [y n] Sets the stop_on_error keyword, which toggles whether to stop processing the distribution for a target if an error occurs during distribution to that target (y) or not (n). The default is y. S path Sets the src_relpath keyword, which specifies the absolute path for all relative paths used in the file package definition. -v int Sets the progs_timeout keyword, which sets a timeout value for all configuration programs specified in the file package. Specify int in seconds; the default is -1, which enables the configuration program to run until completion (no timeout). x [y n] Sets the do_checksum keyword, which performs a checksum parity check on the file package when it is distributed. UNIX Keyword Options g gid Sets the unix_default_file_gid keyword, which sets the default group ID (any decimal value valid as a GID on a UNIX target or name of a group valid on the TMR server) for all files and links distributed in the file package. The default is to preserve the group ID of the source Version 3.6

191 wsetfpopts G gid Sets the unix_default_dir_gid keyword, which sets the default group ID (any decimal value valid as a GID on a UNIX target or name of a group valid on the TMR server) for all directories distributed in the file package. The default is to preserve the group ID of the source. u uid Sets the unix_default_file_uid keyword, which sets the default user ID (any decimal value valid as a UID on a UNIX target or name of a user valid on the TMR server) for all files and links distributed in the file package. The default is to preserve the user ID of the source. U uid Sets the unix_default_dir_uid keyword, which sets the default user ID (any decimal value valid as a UID on a UNIX target or name of a user valid on the TMR server) for all directories distributed in the file package. The default is to preserve the user ID of the source. p path Sets the unix_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to UNIX targets. NetWare Keyword Options p path Sets the nw_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to NetWare targets. V [y n] Sets the nw_bindery keyword, which indicates whether to login to the NetWare 4.x server in bindery mode, thus, emulating a NetWare 3.x machine. If you set this keyword (y), the nw_context and nw_tree keywords are ignored. The default for this option is n. x context Sets the nw_context keyword, where context specifies the directory services context for a distribution to a NetWare 4.x server. The context argument must be a string that specifies a valid directory services context on the NetWare target. Commands TME 10 Software Distribution Reference Manual 2 81

192 wsetfpopts y tree Sets the nw_tree keyword, where tree specifies a directory services tree to which to distribute a file package on a NetWare target. The tree argument must be a string that specifies a valid directory services tree on the NetWare target. Y [y n] Sets the nw_force_disconnect keyword, which specifies whether to break a lock on a file and replace the file during a distribution to a NetWare target. The default for this option is n. z [y n] Sets the nw_broadcast_mode keyword, which specifies whether to broadcast the message specified by the nw_broadcast_message keyword to all NetWare targets of a distribution (y) or only those targets that have locked files which will be distributed (n). The default is n. Z message Sets the nw_broadcast_message keyword, where message is a string up to 255 characters that is broadcast to NetWare targets prior to distribution. Windows Keyword Options w [y n] Sets the win_optional_dist keyword, which specifies an optional (y) or mandatory (n) distribution. Optional distribution displays a dialog at distribution or removal time on the target from which the user can choose to receive the distribution or removal. The default setting is n. If the setting is y and the user does not respond, the distribution or removal is automatically performed within win_optional_dist_timeout seconds. W int Sets the win_optional_dist_timeout keyword, which specifies the number of seconds (any decimal from 1 to 6000) that the win_optional_dist dialog is displayed. The default is 120 seconds. p path Sets the win_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to Windows targets Version 3.6

193 wsetfpopts Windows 95 Keyword Options w [y n] Sets the win95_optional_dist keyword, which specifies an optional (y) or mandatory (n) distribution. Optional distribution displays a dialog at distribution or removal time on the target from which the user can choose to receive the distribution or removal. The default setting is n. If the setting is y and the user does not respond, the distribution or removal is automatically performed within win95_optional_dist_timeout seconds. W int Sets the win95_optional_dist_timeout keyword, which specifies the number of seconds (any decimal from 1 to 6000) that the win95_optional_dist dialog is displayed. The default is 120 seconds. p path Sets the win95_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to Windows 95 targets. Windows NT Keyword Options p path Sets the nt_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to Windows NT targets. OS/2 Keyword Options p path Sets the os2_platform_prefix keyword, which prepends the specified path to all destination paths for distributions to OS/2 targets. Return Codes The wsetfpopts command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. Commands TME 10 Software Distribution Reference Manual 2 83

194 wsetfpopts EXAMPLES To set the value of the append_log keyword to y, enter the following: wsetfpopts -T gen -a To reset the value of the append_log keyword to its default, enter: wsetfpopts -t gen To set the value of the unix_default_file_uid keyword, enter: wsetfpopts -T unix -u To set the progs_timeout keyword, enter: wsetfpopts -T unix -v The -v keyword sets a client-level timeout value for all configuration programs specified in the file package. To set the prog_env keyword to a value that will make the destination path for the UNIX targets, the mail IDs that will receive information about the status of this operation, and the file package name available to any configuration programs running on UNIX targets, enter the following command: wsetfpopts -T gen -E UNIX_DEST=\$unix_platform_prefix\ \ MAIL_USERS=\ \$mail_id\ \ FPNAME=\ \$fpname\ example_fp 1 You must escape (using back slashes) all spaces in the string following the E argument so that the shell treats the string as one logical value for the argument. You must also escape all (shell) special characters. This prevents the shell from interpreting, for example, $mail_id as a shell variable. Finally, because the values of the mail_id keyword and the file package name might contain spaces, you must quote the MAIL_USERS and FPNAME variables (using single quotation 2 84 Version 3.6

195 wsetfpopts marks) to ensure that the complete values are set. After you run this command, the prog_env variable is set to the following: prog_env= UNIX_DEST=$unix_platform_prefix MAIL_USERS= $mail_id FPNAME= $fpname SEE ALSO wsetfpcontents, wsetfpprgs Commands TME 10 Software Distribution Reference Manual 2 85

196 wsetfpprgs NAME PURPOSE SYNOPSIS wsetfpprgs Sets or modifies the before, after, remove, after removal, commit, or on error program information associated with a file package. wsetfpprgs { t type T type} [keyword_options] fp_name DESCRIPTION This command enables you to specify the configuration program to be run on the source host or target. If you specify multiple configuration programs of the same type, you must separate them with commas. Likewise, to specify input files for multiple programs, you must also separate them with commas. The programs must reside on the same target or source and are processed in the order in which you specify them. If a program does not require an input file but subsequent programs do, you must specify the input files in the correct order and preceded by the same number of commas as the programs. Do not follow commas with spaces. If you specified multiple before programs and one fails, subsequent before programs will run if you did not enable the Stop distribution on error option on the File Package Properties window (unix_before_skip_non_zero=y). Otherwise, the distribution stops and subsequent programs will not run. If you specified multiple programs of any other type and one fails, the distribution stops and Software Distribution will not run subsequent programs. The wsetfpprgs command also enables you to specify whether programs and input files reside on the source host or a target. If the programs and input files reside on the source host (using the A, B, C, D, E, F, G, I, J, K, L, N, and R arguments), you can specify a relative path to them. Software Distribution runs the programs and obtains the input files from the path specified by the src_relpath keyword. If the programs and input files reside on the target, you must specify a full path to each. By default, programs that 2 86 Version 3.6

197 wsetfpprgs Authorization Arguments run on a target reside on that target. Source before and after programs reside on the source. The wsetfpprgs command cannot manipulate the files of a file package (wsetfpcontents), nor the file package options (wsetfpopts). admin, senior or super t type Sets the specified keyword option to its default value. The type argument specifies the type of platform on which the program is run. Software Distribution looks for default settings in the file package s policy region first. If the default is not set there, Software Distribution adopts the defaults as described in Chapter 1, File Package Definitions. Do not specify arguments with the keyword option. Do not specify arguments with t type keyword options for example, -t unix -v does not require any arguments after the -v keyword option. Valid types are shown below, with their valid keyword options: src unix nw Keyword options that apply to running a program on the source host. Valid keyword options for src are: a, b, i, s, u, and U. See below for keyword option descriptions. Keyword options that apply to running a program on a UNIX target machine. Valid keyword options for unix are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, i, I, j, J, k, K, l, L, r, R, s, u, U v, V, w, and W. See below for keyword option descriptions. Keywords that apply to running a program on a NetWare target machine. Valid keyword options for nw are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, Commands TME 10 Software Distribution Reference Manual 2 87

198 wsetfpprgs win win95 nt i, I, j, J, k, K, l, L, M, n, N, r, R, and s. See below for keyword option descriptions. Keywords that apply to running a program on a Windows target machine. Valid keyword options for win are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, i, I, j, J, k, K, l, L, o, O, p, P, q, r, R, and s. See below for keyword option descriptions. Keywords that apply to running a program on a Windows 95 target machine. Valid keyword options for win95 are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, i, I, j, J, k, K, l, L, o, O, p, P, q, r, R, and s. See below for keyword option descriptions. Keywords that apply to running a program on a Windows NT target machine. Valid keyword options for nt are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, i, I, j, J, k, K, l, L, o, O, P, q, r, R, and s. See below for keyword option descriptions. os2 Keywords that apply to running a program on an OS/2 target machine. Valid keyword options for os2 are: a, A, b, B, c, C, d, D, e, E, f, F, g, G, i, I, j, J, k, K, l, L, r, R, and s. See below for keyword option descriptions. T type Sets the specified keyword option to the specified argument. The type argument specifies the type of platform on which the program is run. Valid values are src, unix, nw, win, win95, nt, and os2, as described above Version 3.6

199 wsetfpprgs keyword_options Specifies the configuration program keyword values to be set for the file package. If used with the t specifier, the keyword is reset to its default value. If used with the T specifier, the keyword is set to a user-specified value as indicated below. Valid values are as follows: path A fully-specified path for a file. y n YES or NO, respectively. uid A numeric user ID. Each of the keyword options can specify different keywords, depending on the type specified with the T argument. For this reason, xxx is used in the keyword description in place of the host or target type. For example, for the keyword option a (listed as xxx_after_prog_path) the keyword is set to src_after_prog_path if you specify type as src. Specific keywords are described in detail in Chapter 1, File Package Definitions a path Sets the xxx_after_prog_path keyword, which runs path on each target (or the source host) after a file package s files are applied. A [y n] Sets the xxx_after_prog_from_src keyword, where y indicates that xxx_after_prog_path resides on the source host, and n that it reside on each target. b path Sets the xxx_before_prog_path keyword, which runs path on each target (or the source host) before a file package s files are applied. B [y n] Sets the xxx_before_prog_from_src keyword, where y indicates that xxx_before_prog_path resides on the Commands TME 10 Software Distribution Reference Manual 2 89

200 wsetfpprgs source host, and n that it resides on each target. c path Sets the xxx_commit_prog_path keyword, which runs path on each target during a commit operation. C [y n] Sets the xxx_commit_prog_from_src keyword, where y indicates that xxx_commit_prog_path resides on the source host, and n that it resides on each target. d path Sets the xxx_after_removal_prog_path keyword, which runs path on the target after removing the file package. D [y n] Sets the xxx_after_removal_prog_from_src toggle, where y indicates that xxx_after_removal_prog_path resides on the source host, and n that it resides on each target. e path Sets the xxx_after_removal_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_after_ removal_prog_path. This keyword is only applicable if the d argument (xxx_after_removal_prog_path) is set. E [y n] Sets the xxx_after_removal_input_from_src toggle, where y indicates that xxx_after_removal_input_path resides on the source host, and n that it resides on each target. f path Sets the xxx_on_error_prog_path keyword, which runs path on the target if an error stops a file package distribution Version 3.6

201 wsetfpprgs F [y n] Sets the xxx_on_error_prog_from_src toggle, where y indicates that xxx_on_error_prog_path resides on the source host, and n that it resides on each target. g path Sets the xxx_on_error_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_on_error_prog_path. This keyword is only applicable if the f argument (xxx_on_error_prog_path) is set. G [y n] Sets the xxx_on_error_input_from_src toggle, where y indicates that xxx_on_error_input_path resides on the source host, and n that it resides on each target. i path Sets the xxx_after_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_after_prog_path. This keyword is only applicable if the a argument (xxx_after_prog_path) is set. I [y n] Sets the xxx_after_input_from_src keyword, where y indicates that xxx_after_input_path resides on the source host, and n that it resides on each target. j path Sets the xxx_before_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_before_prog_path. This keyword is only applicable if the b argument (xxx_before_prog_path) is set. J [y n] Sets the xxx_before_input_from_src keyword, where y indicates that xxx_after_prog_path resides on the Commands TME 10 Software Distribution Reference Manual 2 91

202 wsetfpprgs source host, and n that it resides on each target. k path Sets the xxx_commit_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_commit_prog_path. This keyword is applicable only if the c argument (xxx_commit_prog_path) is set. K [y n] Sets the xxx_commit_input_from_src keyword, where y indicates that xxx_commit_input_path resides on the source host, and n that it resides on each target. l path Sets the xxx_removal_input_path keyword, which passes path as standard input (or arg[2] on PCs) to xxx_removal_prog_path. This keyword is applicable only if the r argument (xxx_removal_prog_path) is set. L [y n] Sets the xxx_removal_input_from_src toggle, where y indicates that xxx_removal_input_path resides on the source host, and n that it resides on each target. M [y n] Sets a NetWare specific option, the nw_login_replace keyword, where y indicates that the trustee login scripts are overwritten, and n that they should be appended. This function only occurs during commit operations. The default is n. This option is applicable only when nw_login_prog_path is not NULL. n path Sets a NetWare specific option, the nw_login_prog_path keyword, which specifies the path to a login script. You 2 92 Version 3.6

203 wsetfpprgs cannot specify multiple programs for this keyword. N [y n] Sets a NetWare specific option, the nw_login_get_from_src keyword, where y indicates that nw_login_prog_path resides on the source host, and n that it resides on each target. o [REBOOT RESTART NONE] Sets the xxx_after_option keyword. When this keyword is set to REBOOT, the target reboots after the distribution. RESTART restarts Windows, Windows 95, or Windows NT after the distribution. NONE does not reboot or restart the target. This keyword is only valid for Windows, Windows 95, or Windows NT machines. If an after program is specified and it fails, the system is not restarted. O [REBOOT RESTART NONE] Sets the xxx_commit_option keyword. When this keyword is set to REBOOT, the target reboots after the commit operation runs. RESTART restarts Windows, Windows 95, or Windows NT after the commit. NONE does not reboot or restart the target. This keyword is only valid for Windows, Windows 95, or Windows NT machines. If a commit program is specified and it fails, the system is not restarted. p [REBOOT RESTART NONE] Sets the xxx_removal_option keyword. When this keyword is set to REBOOT, the target reboots after the removal operation runs. RESTART restarts the target after the removal (on Windows, Windows 95, or Windows NT machines). Commands TME 10 Software Distribution Reference Manual 2 93

204 wsetfpprgs NONE does not reboot or restart the target. This keyword is only valid for Windows, Windows 95, or Windows NT machines. If a removal program is specified and it fails, the system is not restarted. Also, if you specify the P argument, the most drastic action specified is performed. For example, if you set p REBOOT and P NONE, the target is rebooted. P [REBOOT RESTART NONE] Sets the xxx_after_removal_option keyword. When this keyword is set to REBOOT, the target reboots after the removal operation runs. RESTART restarts the target after the removal (on Windows, Windows 95, or Windows NT machines). NONE does not reboot or restart the target. This keyword is only valid for Windows, Windows 95, or Windows NT machines. If an after removal program is specified and it fails, the system is not restarted. Also, if you specify the p argument, the most drastic action specified is performed. For example, if you set p REBOOT and P NONE, the target is rebooted. q [REBOOT RESTART NONE] Sets the xxx_on_error_option keyword. When this keyword is set to REBOOT, the target reboots after the removal operation runs. RESTART restarts the target after the removal (on Windows, Windows 95, or Windows NT machines). NONE does not reboot or restart the target. This keyword is only valid for Windows, Windows 95, or Windows NT machines. If an on error program is 2 94 Version 3.6

205 wsetfpprgs specified and it fails, the system is not restarted. r path Sets the xxx_removal_prog_path keyword, which runs path on the target before removing the file package from the subscribers. R [y n] Sets the xxx_removal_prog_from_src keyword, where y indicates that xxx_removal_prog_path resides on the source host, and n that it resides on each target. s [y n] Sets the xxx_before_skip_non_zero keyword, where y indicates that distribution is skipped if xxx_before_prog_path exits with a non-zero exit code, and n indicates that it is not skipped. u uid Sets the src_after_as_uid or unix_after_as_uid keyword, which sets the user ID under which to run src_after_ prog_path or unix_after_prog_path. U uid Sets the src_before_as_uid or unix_before_as_uid keyword, which sets the user ID under which to run src_before_prog_path or unix_before_prog_path. v uid Sets the unix_commit_as_uid keyword, which sets the user ID under which to run unix_commit_prog_path. V uid Sets the unix_removal_as_uid keyword, which sets the user ID under which to run unix_removal_prog_path. w uid Sets the unix_after_removal_as_uid keyword, which sets the user ID under Commands TME 10 Software Distribution Reference Manual 2 95

206 wsetfpprgs fp_name which to run unix_after_removal_prog_path. W uid Sets the unix_on_error_as_uid keyword, which sets the user ID under which to run unix_on_error_prog_path. Specifies an object path or registered name of the file package, as an absolute path or as a registered name. Return Codes The wsetfpprgs command returns the following codes to standard output: 0 Successful completion. 1 The commands failed due to an error. EXAMPLES To set the value of the nt_after_prog_path keyword, enter the following commands: wsetfpprgs -T nt -a To reset the value of the nt_after_prog_path keyword back to its default, enter: wsetfpprgs -t nt SEE ALSO wsetfpcontents, wsetfpopts 2 96 Version 3.6

207 wsettrus NAME PURPOSE SYNOPSIS wsettrus Sets the trustee rights for files and directories. (NetWare only) NetWare 3.x wsettrus u trustee d path r rights DESCRIPTION NetWare 4.x wsettrus u trustee d path r rights [ c context t tree] wsettrus a admin_login p password The wsettrus command sets the trustee rights for files and directories on a NetWare server. You can include this command in an after program to set user and group rights of files and directories after they are distributed by Software Distribution. Use this commands on a NetWare 3.x server as specified by the first synopsis statement. Use the second and third statements on a NetWare 4.x server. The third synopsis statement enables you to set the password for the specified administrator. Set the password from the command line on the NetWare server or prior to the administrator login s use by Software Distribution. Arguments a admin_login Specifies the administrator s login for which you are setting the password. Use this argument in conjunction with the p argument. c context Specifies the directory services context for which to set the rights. You must specify the t argument with this argument. Commands TME 10 Software Distribution Reference Manual 2 97

208 wsettrus d path Specifies the fill path of the file or directory for which you are setting trustee rights. p password Sets the password of the administrator login specified by the a argument. This password is encrypted and must be set prior to Software Distribution using the administrator s login. r rights Sets the rights for the user or group specified by the u argument. The following rights are available. R (read), W (write), C (create), E (erase), A (access control), F (file scan), M (modify), and S (supervisor) t tree Specifies the directory services tree for which to set the rights. You must specify the c argument with this argument. u trustee Specifies the user or group for which you are setting rights. EXAMPLES The following command example sets the password for the JrAdmin administrator login on a NetWare 4.x machine. wsettrus -a JrAdmin -p toilntrouble To set the WRM rights (write, read and modify rights) for the user Magee on the SYS:\PUBLIC directory, enter the following command: wsettrus -u Magee -d SYS:\PUBLIC -r WRM To set supervisory (S) rights for Smith on the SYS:\PUBLIC directory. These rights are set in the o=my_company context of the marketing tree of the NetWare 4.x server. wsettrus -u Smith -d SYS:\PUBLIC -r S -c o=my_company \ -t marketing 2 98 Version 3.6

209 wsetval NAME PURPOSE SYNOPSIS wsetval Sets a registry key value. (Windows 95 and Windows NT only) wsetval [ h registry_hive] { k n value_name { v DESCRIPTION The wsetval command replaces a key value in the registry. If the key or value does not exist, it is created. Authorization administrator Arguments h registry_hive Specifies the registry hive to update. Valid values are: HKEY_LOCAL_MACHINE (default) HKEY_CURRENT_USER HKEY_CLASSES_ROOT HKEY_USERS k Specifies the key in which the value is inserted. If the first character of the key the key is read from filename. n value_name Specifies the name of the value. v Specifies the value or file that contains the value. Commands TME 10 Software Distribution Reference Manual 2 99

210 wsetval EXAMPLE To add the NOTEPAD subkey under the existing SOFTWARE key, and assign the NOTEPADVAR key value name in the HKEY_LOCAL_MACHINE hive, enter the following command: wsetval -h HKEY_LOCAL_MACHINE -k SOFTWARE\NOTEPAD \ -n NOTEPADVAR -v C:\TEMP\NTPADVAR.FIL Version 3.6

211 wswdistrim NAME PURPOSE SYNOPSIS wswdistrim Sets the tracking feature to control when the TME 10 Inventory configuration repository is updated with information about Software Distribution operations. wswdistrim {-c -d} DESCRIPTION The wswdistrim command is used to disable and then re-enable the tracking feature from the command line to control when Software Distribution information is posted to the configuration repository. When this feature is enabled, the TME 10 Inventory configuration repository is updated with information about file packages, AutoPacks, and file package blocks (fpblocks) that have been installed or removed in the TME 10 environment. Tivoli suggests that you disable the tracking feature prior to deploying a file package for which you do not want to track distribution statistics. Re-enable the tracking feature to resume tracking distribution information in the configuration repository. Authorization senior or super Arguments c Re-enables the tracking feature. d Disables the tracking feature. Commands EXAMPLES To disable the tracking feature, enter: wswdistrim -d TME 10 Software Distribution Reference Manual 2 101

212 wswdistrim To re-enable the tracking feature, enter: wswdistrim -c Version 3.6

213 3 3Policy TME 10 policy enables you to control the default values of newly-created resources (default policy) and to maintain guidelines when administrators modify or operate on resources (validation policy). Specifically, the TME 10 Software Distribution default and validation policies enable you to set defaults and enforce guidelines for file package and AutoPack properties and operations. These policies are implemented as shell scripts or programs UNIX scripts (such as Bourne, K, and Perl shells), awk programs, C programs, and so on. Default policies set the default values for file package and AutoPack properties. These policies are useful if you want to preset file package and AutoPack properties with specific values. For example, if most of your file packages will have the same source host, you could define a default policy so that every newly-created file package has its source host set to that machine. You can change properties set to a value by a default policy (if you do not violate validation policy). Similarly, validation policy ensures that file package and AutoPack properties or operations always adhere to rules. For example, you can create a script for the ap_val_name policy method specifying that AutoPack names cannot contain punctuation marks or slashes. For example, if an administrator attempts to name an AutoPack data\upgrades, the validation fails and the administrator must select another name, such as data-upgrades. Software Distribution policy is policy-region based. When you set a default or validation policy, that policy method generally runs on the TMR server in the policy region in which the file package or AutoPack Policy TME 10 Software Distribution Reference Manual 3 1

214 Default Policy Methods resides. The policy applies to all file package or AutoPack resources in that policy region. The names of the methods and their inputs remain the same. Note: Policy methods that do NOT run in the policy region where the resource resides include fp_val_src_host and ap_val_autopack_ host_file. These methods run in the policy region where the source host resides for the file package or AutoPack, respectively. Finally, it is important to mention that because these resources can only reside on UNIX or NT managed nodes, the policy methods must be UNIX or NT scripts, programs, or executables. Tivoli recommends that, because policies are stored in the database, you write your policy methods in an interpreter language to save space. Executables (compiled programs) are generally larger. An interpretive program can often be used across multiple platforms; executables often cannot. Thus, use UNIX scripts or UNIX managed nodes. Use.BAT,.EXE, or.com files, in addition to UNIX scripts or programs if the necessary tools are available, on the NT machine. Do not use C shell scripts. For more information on default and validation policy and policy regions, see the TME 10 Framework User s Guide. Default Policy Methods Default policy methods are shell scripts or programs invoked by Software Distribution when you create a new file package and AutoPack. By creating scripts or programs and replacing the contents of these policy methods, you can automatically set the properties in newly-created file packages and AutoPacks. When Software Distribution invokes a default policy method, the name of the file package or AutoPack being created is passed to the method. Software Distribution expects the default policy methods to exit with the code 0, so you must write your policy methods to do so. Reserve other exit codes for hard errors, such as insufficient memory, incorrect usage, and so on. 3 2 Version 3.6

215 Default Policy Methods The default policy methods available with Software Distribution are as follows: Method ap_def_autopack_file ap_def_autopack_host fp_def_excludes fp_def_flist fp_def_nestedlist fp_def_options fp_def_src_host Purpose Generates the default AutoPack file of the AutoPack. Generates the default source host for the AutoPack. This source host is the managed node on which the AutoPack file resides. Generates the default list of files and directories to be excluded from a file package. Generates the default list of files to be included in the file package. Generates the default list of nested file packages and directories to be included in the file package. Generates the default options for the file package. Generates the default source host for the file package. Policy TME 10 Software Distribution Reference Manual 3 3

216 Default Policy Methods Default Policy Methods for AutoPacks When you set or edit an AutoPack default policy, you will see the default value in the indicated section of the following dialog. ap_def_autopack_host ap_def_autopack_file The following default policy method examples are UNIX Bourne shell scripts that set various AutoPack properties. Those scripts that simply echo a value are only responsible for setting one file package or AutoPack option. To set the default AutoPack file for a newly-created AutoPack, create the following script for the ap_def_autopack_file policy method. #!/bin/sh echo /usr/local/autopacks/name.pak exit 0 To set the default source host where all newly-created AutoPacks will reside to pescado, create the following script for the ap_def_autopack_host policy method: #!/bin/sh echo pescado exit Version 3.6

217 Default Policy Methods for File Package Default Policy Methods The following illustration maps the file package default policy methods to the File Package Properties window. When you set or edit a policy, you will see the default value in the indicated section of the dialog. Note that values set by the fp_def_excludes policy method are not available from the desktop. fp_def_src_host fp_def_flist fp_def_options fp_def_nestedlist Policy Note: The file package options available on the platform-specific options dialogs are set by the fp_def_options policy. The following illustration maps the default policy methods to the file package definition. If you choose to set file package properties using export/import, you will see the values set by a default policy method in the indicated section of the exported file package definition. Note TME 10 Software Distribution Reference Manual 3 5

218 Default Policy Methods that the value of the fp_def_src_host policy method is not available in the file package definition. header fp_def_options fp_def_flist fp_def_nestedlist fp_def_excludes The following default policy method examples are UNIX Bourne shell scripts that set various file package properties. Those scripts that simply echo a value are only responsible for setting one file package or AutoPack option. To set the source host to jazz for all newly-created file packages, create the following script for the fp_def_src_host policy method: #!/bin/sh PATH=/bin:/usr/bin echo jazz exit 0 To set the rm_empty_dirs, descend_dirs, do_compress, and append_log keywords to y and set the keep_paths keyword to n, and to set the UNIX destination directory to /staging/fp_name, create the following script for the fp_def_options policy method: #!/bin/sh PATH=/bin:/usr/bin 3 6 Version 3.6

219 Default Policy Methods fp_name= $1 cat <<EOF rm_empty_dirs=y descend_dirs=y keep_paths=n do_compress=y append_log=y unix_platform_prefix=/staging/$fp_name EOF exit 0 To exclude the /etc/log directory, /etc/default directory, and any file or directory named core from file packages, create the following script for the fp_def_excludes policy method: #!/bin/sh PATH=/bin:/usr/bin echo /etc/log echo /etc/default echo core exit 0 To nest the new scripts, barcprogs, and docs file packages in all newly-created file packages, create the following script for the fp_def_nestedlist policy method: #!/bin/sh PATH=/bin:/usr/bin cat <<EOF new scripts barcprogs docs EOF exit 0 To include the /app/readme and /pub/support files in all new file packages, create this script for the fp_def_flist policy method: Policy #!/bin/sh PATH=/bin:/usr/bin cat <<EOF /app/readme /pub/support EOF exit 0 TME 10 Software Distribution Reference Manual 3 7

220 Validation Policy Methods Validation Policy Methods Validation policy methods are called when file package or AutoPack properties are set or modified. Validation policy also ensures that an attempted file package or AutoPack operation is allowed. When you modify or perform an operation on a file package using the File Package Properties window, export/import, the command line, or the Distribute File Package dialog, the file package validation policy methods are invoked. When you modify or perform an operation on an AutoPack using the Set AutoPack Properties, Distribute AutoPack, or Remove AutoPack dialog, the AutoPack validation policy methods are invoked. Validation policy methods are shell scripts or programs that Software Distribution automatically calls when you perform any of these actions. Initially, the validation policy methods are not set. Thus, when you create, modify, or perform an operation on a file package or AutoPack, none of the properties are checked. By creating scripts or programs and replacing the contents of these validation policy methods, you can control changes to the file package or AutoPack properties. Validation policy methods receive as input the proposed value of the file package or AutoPack property or the attempted file package or AutoPack operation. They return TRUE if the input passes validation or FALSE if not. For example, Software Distribution always invokes the fp_val_options policy method to verify proposed file package options. If an option does not adhere to the guidelines set by this policy method, the validation fails and the method returns FALSE. TME 10 Software Distribution expects the validation policy methods to exit with the code 0 if successful even if the input does not pass validation. Reserve other error codes for hard errors, such as insufficient memory, incorrect usage, and so on. In general, policy methods run in the policy region of the file package or AutoPack. However, the fp_val_src_host, fp_val_delete_src_host, and ap_val_autopack_host_file policy methods run in the policy region of the source host, which may differ from the policy region of the file package or AutoPack. 3 8 Version 3.6

221 Validation Policy Methods The following validation policy methods are available with Software Distribution: Method ap_val_autopack_host_file ap_val_name ap_val_operation fp_val_delete_src_host fp_val_excludes fp_val_flist fp_val_name Purpose Validates the proposed source host and source file for an AutoPack. Validates the proposed name when you change the name of an existing AutoPack. Validates the operations performed on the AutoPack. Validates the removal of the source host for a file package. When the source host of a file package is changed from one host to another, this method first validates the unsetting of the original source host. Validates the files and directories to be excluded from the file package. Validates the files and directories to be included in the file package. Validates the proposed name of the file package. fp_val_nestedlist fp_val_operation Validates the nested file packages to be included in the file package. Validates the operations performed on file packages. Policy fp_val_options fp_val_src_host Validates file package properties. Validates the proposed source host of the file package. TME 10 Software Distribution Reference Manual 3 9

222 Validation Policy Methods Validation Policy Methods for AutoPacks When you set or edit an AutoPack, the validation policy method that corresponds to that property is invoked. ap_val_name ap_val_autopack_host_file ap_val_operation ap_val_operation 3 10 Version 3.6

223 Validation Policy Methods ap_val_operation The following examples provide UNIX shell scripts for various AutoPack validation policy methods. To ensure that a newly-created AutoPack does not reside in a directory with xyz in its name, and to ensure that the source host is not pescado, create the following script for the ap_val_autopack_host_file policy method: #!/bin/sh LABEL=$1 HOST=$2 FILEPATH=$3 # Note: it is easier to use grep -q here but the # NT version of grep doesn t support the -q switch Policy ignore=`echo $FILEPATH grep xyz` if [ $? -eq 0 ]; then echo FALSE exit 0 fi if [ $HOST = pescado ]; then echo FALSE exit 0 fi echo TRUE exit 0 TME 10 Software Distribution Reference Manual 3 11

224 Validation Policy Methods To ensure that the proposed name of an existing AutoPack contains the letters auto, create the following script for the ap_val_name policy method: #!/bin/sh set +e LABEL=$1 NEW_LABEL=$2 ignore=`echo $NEW_LABEL grep auto` if [ $? -eq 0 ]; then echo TRUE else echo FALSE fi exit 0 To ensure that AutoPack files cannot be copied from the birch managed node, create the following script for the ap_val_operation policy method. #!/bin/sh OPERATION=$1 if [ $OPERATION == COPY ]; then SRCHOST=$3 if [ $SRCHOST == birch ]; then echo FALSE exit 0 fi fi echo TRUE exit Version 3.6

225 Validation Policy Methods for File Packages Validation Policy Methods The following illustrations map the file package validation policy methods to the File Package Properties window, the Remove File Package dialog, and the Distribute File Package dialog. When you set or edit a file package property, the validation policy method that corresponds to that property is invoked. fp_val_name fp_val_src_host fp_val_del_src_host fp_val_list fp_val_options fp_val_nestedlist Policy TME 10 Software Distribution Reference Manual 3 13

226 Validation Policy Methods Note: The file package options available on the platform-specific options dialogs are validated by the fp_val_options policy. fp_val_operation 3 14 Version 3.6

227 Validation Policy Methods fp_val_operation Policy The following illustration maps the validation policy methods to the file package definition. If you choose to set file package properties using export/import, the validation policy method that corresponds to a changed property is invoked. The fp_val_name, the fp_val_operation, the fp_val_delete_src_host, and the TME 10 Software Distribution Reference Manual 3 15

228 Validation Policy Methods fp_val_src_host policy method are not invoked by changes to the file package definition. header fp_val_options fp_val_flist fp_val_nestedlist fp_val_excludes The following examples provide UNIX shell scripts and a C program for various validation policy methods. To ensure that an attempted operation (except for a commit operation) is valid anytime except for Monday-Friday, 8 a.m. - 5 p. m., create the following script to set the fp_val_operation policy method. This script is invoked at the start of a Software Distribution distribute, distribute and commit, commit, preview, or remove operation. The script indicates validation failure if the current day and time is within this 8 a.m. -5p.m.time period. In such a case, the script exits with a return code of 0 and echoes FALSE. The script will also fail if it is called with the incorrect number of arguments. In this case, it will exit with a return code of 0 and echo FALSE. When this program is called, the name of the file package is passed as the first argument to the program. The type of operation is passed as the second argument. #!/bin/sh export PATH 3 16 Version 3.6

229 Validation Policy Methods FP_NAME=$1 FP_OP=$2 DAY=`date +%w` HOUR=`date +%H` # Allow a commit operation if [ $FP_OP = COMMIT ]; then echo TRUE exit 0 fi # If it s Sunday or Saturday, return SUCCESS if [ $DAY = 0 ] [ $DAY = 7 ] ; then echo TRUE exit 0 fi # If the day is Monday-Friday, ensure that the hour is not # between 0800 (8am) and 1700 (5pm) if [ $HOUR -ge 8 ] && [ $HOUR -lt 17 ]; then echo FALSE exit 0 fi echo TRUE exit 0 To ensure that the file names in the flist are not longer than eight characters and their extensions are no longer that three characters (so that they conform to Windows file name conventions, for example), create the following Perl script for the fp_val_flist policy method. This script does not check files contained in directories, commands, or wildcard character file names included in the flist. When this program is called, the flist is passed through standard input. The name of the file package is passed as the first argument to the program. Policy #!/usr/local/bin/perl while (<STDIN>) { # Truncate override options ($PathName) = split(/\w*\s+\w*/, $_); # Get the basename of the path $FileName = &Basename($PathName); # Separate into a filename and an extension ($Name, $Ext) = split(/\./, $FileName); if (length($name) > 8) { print FALSE ; TME 10 Software Distribution Reference Manual 3 17

230 Validation Policy Methods exit(0); } if (length($ext) > 3) { print FALSE ; exit(0); } } # Validation succeeded! print TRUE ; exit(0); # # Return the basename for the specified path # sub Basename { local($filename) $filename =~ s#.*/##; $filename; } To validate the file package options descend_dirs, stop_on_error, and post_notice, create the following C program for the fp_val_options policy method. When this program is called, the option list is passed through standard input. The name of the file package is passed as the first argument to the program. If the file package does not pass validation, error messages indicating the reason are written to the /tmp/filepackname.err file, FALSE is written to standard output, and the program exits with a nonzero exit code. If the file package passes validation, TRUE is written to standard output and the program exits with exit code 0. The executable for this program will always run on the TMR server for the associated policy region, so it should be compiled for that platform type. The error file will also be created on the TMR server. #include <sys/types.h> #include <stdio.h> #include <string.h> typedef struct validate_entry { char *keyword; char *value; } val_entry_t; val_entry_t validate_table[] = { descend_dirs, y, 3 18 Version 3.6

231 Validation Policy Methods stop_on_error, y, post_notice, y }; #define VAL_SIZE (sizeof(validate_table)/sizeof(val_entry_t)) #define MAX_LINE 1024 char buf[max_line]; #define ERRFILE_PREFIX /tmp/ #define ERRFILE_EXT.err static void output_bad_keyword(char *fpname, char *keyword, char *bad_val, char *exp_val); main(argc, argv) int argc; char **argv; { int i; char *s; char *value_ptr; char *keyword_ptr; /* Read lines from stdin. Eack keyword/value pair will * be on a new line */ while ((s = gets(buf))!= NULL) { keyword_ptr = buf; /* Options should always appear in the form: keyword=value * If this line contains a keyword value pair, then * separate the keyword and value into separate strings */ if ((value_ptr = strchr(buf, = )) == NULL) { /* If we didn t find an equal sign, just skip this line, * we re not interested in it. */ continue; } *value_ptr++ = \0 ; for (i = 0; i < VAL_SIZE; i++) { /* Look through our local table to see if this is a * keyword we want to validate. If so, ensure * it matches our required value */ if ((strcmp(keyword_ptr, validate_table[i].keyword) == 0) && (strcmp(value_ptr, validate_table[i].value)!= 0)) { /* The option did not match our required value. * Fail the validation */ output_bad_keyword(argv[1], keyword_ptr, validate_table[i].value, value_ptr); printf( FALSE ); exit(0); } } } /* Everything looks ok */ printf( TRUE ); Policy TME 10 Software Distribution Reference Manual 3 19

232 Validation Policy Methods exit(0); } /* Write to error file indicating which keyword failed validation */ static void output_bad_keyword(fpname, keyword, bad_val, exp_val) char *fpname; char *keyword; char *bad_val; char *exp_val; { FILE *err_fd; char *err_fname; err_fname = (char *)malloc(strlen(fpname) + strlen(errfile_prefix) + strlen(errfile_ext) + 1); if (err_fname == NULL) { return; } sprintf(err_fname, %s%s%s, ERRFILE_PREFIX, fpname, ERRFILE_EXT); if ((err_fd = fopen(err_fname, w ))!= NULL) { fprintf(err_fd, Validation failed for file package: %s\n, fpname); fprintf(err_fd, Keyword is: %s\n, keyword); fprintf(err_fd, Expected value is : %s\n, exp_val); fprintf(err_fd, Value in file package is: %s\n, bad_val? bad_val : NULL ); fclose(err_fd); } } In addition, the following Perl script validates the do_compress, descend_dirs, log_file, and append_log file package options: #!/etc/tivoli/bin/perl # FP_VAL_OPTIONS: Validate File Package Options # usage: fp_val_options fp_name < options # The following associative array defines the keywords # of interest and their required values: %check = ( do_compress, y, descend_dirs, y, log_file, fuji:/home/dist/dist_log, append_log, y, ); # Check usage 3 20 Version 3.6

233 Validation Policy Methods if ne 1 ) { die( usage: fp_val_options fp_name < options\n ); } else { ($fp_name) # (unused) } $status = TRUE ; # Iterate over each line on standard input. # Split each line into keyword and value around the =. # If the keyword is present in the check array (as an index), # make sure the value matches the required one as defined # in the array. Otherwise, set the status and exit the # while loop. while ( <STDIN> ) { chop; # discard trailing new line ($keyword, $value) = split( =, $_, 2); if (defined $check{$keyword} && $value ne $check{$keyword} ) { $status = FALSE ; last; } } print $status\n ; exit 0; Validation Policy Methods and TME 10 Commands Validation policy methods are also invoked when you set or change file package properties using the command line. The following table describes which commands invoke each validation policy method. Note: Commands that set or edit AutoPack properties are not available; AutoPack policy methods cannot be invoked from the command line. Policy Policy Methods Commands fp_val_delete_src_host wimprtfp -h wsetfpattr -h wsetfpcontents -h TME 10 Software Distribution Reference Manual 3 21

234 Policy Objects fp_val_excludes fp_val_flist Policy Methods wimprtfp Commands wsetfpcontents -E wimprtfp wsetfpcontents -F fp_val_name fp_val_nestedlist wcrtprf wimprtfp wsetfpcontents -N fp_val_operation wcrtfpblock wdistfp wrmfp fp_val_options wimprtfp wsetfpopts wsetfpprgs fp_val_src_host wimprtfp -h wsetfpattr -h wsetfpcontents -h Policy Objects For more information on the wcrtfpblock, wdistfp, wimprtfp, wrmfp, wsetfpattr, wsetfpcontents, wsetfpopts, or wsetfpprgs command, see Chapter 2, Commands. For further information on the wcrtprf command, refer to the TME 10 Framework User s Guide. The default and validation policy methods that govern the FilePackage and AutoPack resources are defined in a policy default object and a policy validation object. The objects for the FilePackage resource are both called BasicFilePackage; the objects for the 3 22 Version 3.6

235 Policy Objects AutoPack resource are called BasicAutoPack. A policy object is a set of policy methods for a specific resource class. Each resource type has two policy objects that define its default and validation policy methods. Each BasicFilePackage and BasicAutoPack policy object and the contained policy methods are provided with Software Distribution. You can, however, create additional policy objects for the FilePackage and AutoPack resources. Multiple policy objects enable you to define different policies that are enforced in different policy regions. For example, suppose you have two policy regions called Data and Software. To create policies that govern the AutoPack operations and properties in each policy region, you can create separate policy objects, such as DataAPpolicy and SoftwareAPpolicy. After you define the policies in each policy object and link the policy objects to the policy regions, any newly-created AutoPacks would adhere to the guidelines you defined. To define a new policy object and its policy methods, you must perform the following procedures: Create a new policy object. Replace the contents of the new policy object methods. Assign the new policy object to the policy region in which the file packages or AutoPacks will reside or to the policy region where the file package source host resides. The following sections provide detailed instructions on each of these procedures for the AutoPack resource. Use these sections to create new policies for the FilePackage resource by substituting FilePackage for AutoPack and by replacing the appropriate policy method name in each step. This is also true for Example Setting a Default Policy Method on page See the TME 10 Framework User s Guide for detailed information about checking policy in a policy region. Policy Creating a New Policy Object To define different policies for multiple policy regions, you must create new policy objects. If you do not define policy for a policy TME 10 Software Distribution Reference Manual 3 23

236 Policy Objects region, TME 10 Software Distribution uses the BasicFilePackage and BasicAutoPack policy objects and their policy methods by default. The following table shows the context and role required for this task: Activity Context Required Role Create a new policy object TMR senior or super You must use the command line to create a new policy object. Enter the following wcrtpol command line to create an AutoPack policy default object: wcrtpol -d AutoPack DataAPpolicy where: d Creates a policy default object. AutoPack Specifies the resource type of the new policy default object. DataAPpolicy Specifies the name of the new AutoPack policy default object. To create an AutoPack policy validation object, enter the following command: wcrtpol -v AutoPack DataAPpolicy where: v Creates a policy validation object. AutoPack Specifies the resource type of the new policy validation object. DataAPpolicy Specifies the name of the new AutoPack policy validation object. After you create a new policy object, you can view the existing policy methods to validate AutoPack properties or operations for a particular policy region using the following commands: 3 24 Version 3.6

237 wlspolm Policy Objects Lists the policy methods for the specified resource. You can list the default or validation policy methods with this command. wgetpolm Retrieves the contents of the specified default or validation policy method. For more information about the wcrtpol, wlspolm, and wgetpolm commands, see the TME 10 Framework Reference Manual. Replacing the Contents of a Policy Method To define different policies from those inherited by the parent policy object, you must create a script or program and replace the existing policy method with it. Note: Policy methods run on managed nodes and thus must be UNIX or NT scripts, programs, or executables. Use UNIX scripts or UNIX managed nodes. Use.BAT,.EXE, or.com files, in addition to UNIX scripts or programs if the necessary tools are available, on the NT machine. Do not use C shell scripts. The following table shows the context and role required for this task: Activity Context Required Role Replace the content of a policy method TMR senior or super You must use the command line to replace the content of a policy method. Policy Enter the following wputpolm command line to replace the contents of the ap_def_autopack_file policy method with the contents of the Data_def_file.sh script: wputpolm -d AutoPack DataAPpolicy ap_def_autopack_file \ < Data_def_file.sh where: -d Specifies that the method is a policy default method. TME 10 Software Distribution Reference Manual 3 25

238 Policy Objects AutoPack Specifies the AutoPack resource type for which the policy is defined. DataAPpolicy Specifies the DataAPpolicy policy object that contains the default policy method being replaced. ap_def_autopack_file Replaces the contents of the ap_def_autopack_file default policy method. < Data_def_file.sh Redirects the Data_def_file.sh script to the command. The contents of this file replace the existing contents of the ap_def_autopack_file policy method. To replace the contents of the ap_val_autopack_host_file policy method with the contents of the Data_val_file.sh script, enter the following command: wputpolm -v AutoPack DataAPpolicy ap_val_autopack_host_file < Data_val_file.sh where: -v Specifies that the method is a policy validation method. AutoPack Specifies the AutoPack resource type for which the policy is defined. DataAPpolicy Specifies the DataAPpolicy policy object that contains the validation policy method being replaced. ap_val_autopack_host_file Replaces the contents of the ap_val_autopack_host_file validation policy method. < Data_val_file.sh Redirects the Data_val_file.sh script to the command. The contents of this file replace the existing contents of the ap_val_autopack_host_file policy method. The Data_val_file.sh file must reside in the directory from which you call the wputpolm command Version 3.6

239 Policy Objects For more information about the wputpolm command, see the TME 10 Framework Reference Manual. Assigning Policy to a Policy Region To change the default policy for a policy region, you must assign policy to the policy region after you have created a new policy object and replaced policy methods. The following table shows the context and role required for this task: Activity Context Required Role Assign policy to a policy region Policy Region senior or super You can use the desktop or command line to assign policy to a policy region. See the TME 10 Framework User s Guide for instructions to use the desktop. To use the wsetpr command to change the default policy in the Data policy region to those methods defined in the DataAPpolicy policy object, enter the following command: wsetpr -d DataAPpolicy where: d DataAPpolicy Changes the default policy to that defined in the DataAPpolicy object. AutoPack Specifies the AutoPack resource type for which the policy is Specifies the Data policy region for which to assign the policy. Policy TME 10 Software Distribution Reference Manual 3 27

240 Example Setting a Default Policy Method To use the command line to change the validation policy in the Data policy region to those methods defined in the DataAPpolicy policy object, enter the following command: wsetpr -v DataAPpolicy where: v DataAPpolicy Changes the validation policy to that defined in the DataAPpolicy object. AutoPack Specifies the AutoPack resource type for which the policy is Specifies the Data policy region for which to assign the policy. For more information about the wsetpr command, see the TME 10 Framework Reference Manual. Example Setting a Default Policy Method The following example provides the complete command line solution of how to set the file package policy default for the backup_fmt and append_log keywords, and how to create and assign policy to a new file package policy object. Use these sections to create new policies for the AutoPack resource by substituting AutoPack for FilePackage and by replacing the appropriate policy method name in each step. 1. List the policy default methods for the FilePackage class by entering the following command from a root prompt: wlspolm -d FilePackage where: d Lists the policy default methods for the FilePackage resource type. FilePackage Specifies the resource whose policy methods are to listed Version 3.6

241 Example Setting a Default Policy Method The following default policies are returned: fp_def_excludes fp_def_flist fp_def_nestedlist fp_def_options fp_def_src_host The fp_def_options policy method is used to set file package options (keywords). 2. List the policy default objects that exist for the FilePackage class. TME 10 supports multiple policy default and validation objects so that, for example, you can have one set of policy objects in policy region X and a different set in policy region Y. Use the following command to list the policy default objects: wlspol -d FilePackage where: d Lists the policy default objects for the FilePackage resource type. (To list the policy validation objects, use the v argument.) FilePackage Specifies the resource whose policy objects are to listed. This command returns only the BasicFilePackage object if you have not created additional policy default objects. 3. Extract the current contents of the fp_def_options policy default method to make sure that another administrator has not modified it. Policy wgetpolm -d FilePackage BasicFilePackage fp_def_options where: d Lists the contents of the fp_def_options policy default method. FilePackage Specifies the FilePackage resource whose policy is to be returned. TME 10 Software Distribution Reference Manual 3 29

242 Example Setting a Default Policy Method BasicFilePackage Specifies the BasicFilePackage policy object whose policy is to be returned. fp_def_options Specifies the policy method whose contents are to be returned. The contents of this policy method are output to standard output by default. If the previous command does not return anything, the policy method is not set. 4. Create a script that sets the backup_fmt keyword. The following script, called /tmp/options.sh, accomplishes this and sets the log_file keyword. #!/bin/sh cat <<EOF backup_fmt=/backups/%p/%f.%n log_file=/dist_logs EOF exit 0 5. Replace the contents of the fp_def_options policy method with the new script using the following command: wputpolm -d FilePackage BasicFilePackage \ fp_def_options </tmp/options.sh where: d Specifies that the fp_def_options policy method is a default policy method. FilePackage Specifies the FilePackage resource for which the policy is set. BasicFilePackage Specifies the BasicFilePackage policy object for which the policy is set. fp_def_options Specifies the fp_def_options policy method whose contents are to be replaced Version 3.6

243 Example Setting a Default Policy Method </tmp/options.sh Redirects the /tmp/options.sh script to the command. This command reads its input from standard input. 6. Associate the new policy method in the BasicFilePackage policy object with the Source policy region: wsetpr -d BasicFilePackage FilePackage where: d BasicFilePackage Changes the default policy to that defined in the BasicFilePackage object. FilePackage Specifies the FilePackage resource type for which the policy is Specifies to change the policy for the Source policy region. After setting the policy, every file package created in policy regions whose default policy for the FilePackage resource type is set to BasicFilePackage will have the backup_fmt and log_file keywords set as specified in the sample script. Policy TME 10 Software Distribution Reference Manual 3 31

244 Policy Methods Policy Methods The following default and validation policy methods enable you to control resources and to maintain guidelines when resources are modified or operated on. These methods can differ from policy region to policy region. That is, one policy region could have one set of validation policy methods and another policy region could have another. Note: The authorization roles listed for each policy method include the roles required to perform the action that calls each policy method, not the role required to create or edit a policy method. For the authorization roles required to create or edit policy, see the roles listed for the wcrtpol, wgetpolm, and wputpolm commands Version 3.6

245 ap_def_autopack_file NAME PURPOSE SYNOPSIS ap_def_autopack_file Generates the default AutoPack file of all newly-created AutoPacks. ap_def_autopack_file ap_name RESOURCE AutoPack DESCRIPTION Authorization Arguments Exit Status This method generates the default AutoPack file of all newly-created AutoPacks. The value displayed in the Path field on the Set AutoPack Properties dialog is the returned value of this method. senior or super ap_name The name of the AutoPack. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. Policy SEE ALSO ap_val_autopack_host_file TME 10 Software Distribution Reference Manual 3 33

246 ap_def_autopack_host NAME PURPOSE SYNOPSIS ap_def_autopack_host Generates the default source host where the AutoPack will reside. ap_def_autopack_host ap_name RESOURCE DESCRIPTION AutoPack This method generates the default source host, a managed node, where the newly-created AutoPack will reside. The value displayed in the Source Host field on the Set AutoPack Properties dialog is the returned value of this method. Authorization senior or super Arguments Exit Status ap_name The name of the AutoPack. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO ap_val_autopack_host_file 3 34 Version 3.6

247 ap_val_autopack_host_file NAME PURPOSE SYNOPSIS ap_val_autopack_host_file Validates the proposed source host and AutoPack file of an AutoPack. ap_val_autopack_host_file ap_name src_host src_file RESOURCE AutoPack DESCRIPTION This method validates the proposed AutoPack file and source host (a managed node) of a newly-created AutoPack. The ap_val_autopack_host_file method runs in the source host s policy region and is invoked when an administrator saves the AutoPack properties specified on the Set AutoPack Properties dialog. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments ap_name src_host src_file The name of the AutoPack. The name of the managed node where the AutoPack file specified by the src_file argument resides. The full path where the AutoPack s file resides on the source host. Policy RETURNS Output The ap_val_autopack_host_file method should write the following strings to standard output: TME 10 Software Distribution Reference Manual 3 35

248 ap_val_autopack_host_file Exit Codes TRUE FALSE Successful validation. Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO ap_def_autopack_file 3 36 Version 3.6

249 ap_val_name NAME PURPOSE SYNOPSIS ap_val_name Validates the proposed name of an AutoPack. ap_val_name old_name new_name RESOURCE AutoPack DESCRIPTION This method validates the new name specified by the new_name argument given to the AutoPack specified by the old_name argument. The ap_val_name method is invoked when the name of the AutoPack is changed. It is also invoked when an AutoPack is created, in which case there is no old name so the new name is passed to the method twice. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments old_name new_name The name of the AutoPack whose name was changed. The new name being validated. Policy RETURNS Output The ap_val_name method should write the following strings to standard output: TRUE Successful validation. FALSE Failed validation. TME 10 Software Distribution Reference Manual 3 37

250 ap_val_name Exit Codes Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error Version 3.6

251 ap_val_operation NAME PURPOSE SYNOPSIS ap_val_operation Validates the AutoPack operation. ap_val_operation {DISTRIBUTE REMOVE} name ap_val_operation COPY name src_host src_file dest_host dest_file RESOURCE AutoPack DESCRIPTION This method validates an AutoPack operation distribute, removal, or copy. It is called when an AutoPack operation is attempted. The list of target PC managed nodes for the distribute and remove operations is available to this method through standard input, with each PC managed node or NT managed node listed on a line by itself. Note the synopsis statements above; only the name argument is present if you are distributing or removing the AutoPack. The copy operation calls this method when an administrator moves an AutoPack from one location to another. If validation is not successful, the operation will not occur. There is no list of targets for this operation because the source and destination are provided on the command line. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments DISTRIBUTE REMOVE COPY The operation to be performed on the AutoPack. name The name of the AutoPack that is the subject of the operation being validated. Policy TME 10 Software Distribution Reference Manual 3 39

252 ap_val_operation src_host src_file dest_host dest_file The host from which the AutoPack is being copied. The source host can be either a managed node or a PC managed node. This argument is present only for the COPY operation. The AutoPack being copied. The source AutoPack can reside on either a managed node or PC managed node. This argument is present only for the COPY operation. The managed node to which the AutoPack is being copied. This argument is present only for the COPY operation. The name of the AutoPack on the destination host where the AutoPack file is being copied. This argument is present only for the COPY operation. RETURNS Output Exit Codes The ap_val_operation method should write the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error Version 3.6

253 fp_def_excludes NAME PURPOSE SYNOPSIS fp_def_excludes Generates the default files and directories to be excluded from a file package. fp_def_excludes RESOURCE FilePackage DESCRIPTION This method generates a list of files and directories to be excluded from the file package and outputs it to standard output. When you set the files and directories to be excluded, you must list them one per line. Authorization senior or super Exit Status Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. Policy SEE ALSO fp_val_excludes See Chapter 1, File Package Definitions for more information on file package definition format. TME 10 Software Distribution Reference Manual 3 41

254 fp_def_flist NAME PURPOSE SYNOPSIS fp_def_flist Generates the default list of files and directories to be included in the file package. fp_def_flist RESOURCE FilePackage DESCRIPTION This method generates the list of files and directories to be included in the file package and outputs it to standard output. When you set the files and directories to be included, you must list them one per line. Authorization senior or super Exit Codes Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_flist See Chapter 1, File Package Definitions for more information on file package definition format Version 3.6

255 fp_def_nestedlist NAME PURPOSE SYNOPSIS fp_def_nestedlist Generates the default list of nested files to be included in the file package. fp_def_nestedlist RESOURCE FilePackage DESCRIPTION This method generates the list of nested file packages to be included in the file package and outputs it to standard output. When you set the value of this method, list each file package, one per line. Authorization senior or super Exit Codes Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. Policy SEE ALSO fp_val_nestedlist See Chapter 1, File Package Definitions for more information on file package definition format. TME 10 Software Distribution Reference Manual 3 43

256 fp_def_options NAME PURPOSE SYNOPSIS fp_def_options Generates the default options for the file package. fp_def_options RESOURCE DESCRIPTION Authorization Exit Codes FilePackage This method generates the file package options and outputs them to standard output. These options include logging, file permission, and general distribution. When you set the values of this method, list each on a separate line in the form of keyword=value. senior or super Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_options See Chapter 1, File Package Definitions for more information on file package definition format Version 3.6

257 fp_def_src_host NAME PURPOSE SYNOPSIS fp_def_src_host Generates the default source host for the file package. fp_def_src_host RESOURCE FilePackage DESCRIPTION This method generates the source host for the file package and outputs it to standard output. When you set the value of this method, you must specify a valid managed node name. Authorization senior or super Exit Codes Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK Successful completion. E_USAGE E_FAIL The method encountered an illegal option, argument, or parameter. The method failed due to an error. Policy SEE ALSO fp_val_src_host and fp_val_delete_src_host See Chapter 1, File Package Definitions for more information on file package definition format. TME 10 Software Distribution Reference Manual 3 45

258 fp_val_delete_src_host NAME PURPOSE SYNOPSIS fp_val_delete_src_host Validates the removal of the source host for a file package. fp_val_delete_src_host fp_name src_host RESOURCE DESCRIPTION FilePackage This method validates that an administrator can change (thereby removing) the source host, as specified by the src_host argument, of an existing file package, as specified by the fp_name argument. It is called when the source host for a file package is changed. Use this method, for example, to enforce a restriction that a certain file package must have a specific host as its source host. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments fp_name src_host The name of the file package whose source host is changed (removed). The name of the managed node that is currently the source host for the file package. If no source host is currently specified for the file package, this value will be NO_SOURCE_HOST Version 3.6

259 RETURNS Output Exit Codes fp_val_delete_src_host The fp_val_delete_src_host method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_def_src_host and fp_val_src_host See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 47

260 fp_val_excludes NAME PURPOSE SYNOPSIS fp_val_excludes Validates the files and directories to be excluded from a file package. fp_val_excludes fp_name RESOURCE DESCRIPTION FilePackage This method validates the list of files and directories to be excluded from the file package specified by the fp_name argument. Use this method to control the list of files to be excluded from the file package. When a file package property such as the contents, an option, or an excluded file is changed, this method and these listed methods are invoked: fp_val_flist fp_val_nestedlist fp_val_options fp_val_src_host The list of files to be excluded is available to the method through standard input. The files are listed one per line. This list can be empty if there are no files to be excluded. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments fp_name The name of the file package for which the files to be excluded are validated Version 3.6

261 RETURNS Output Exit Codes fp_val_excludes The fp_val_excludes method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_flist, fp_val_nestedlist, fp_val_options, fp_val_src_host See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 49

262 fp_val_flist NAME PURPOSE SYNOPSIS fp_val_flist Validates the files and directories to be included in a file package. fp_val_flist fp_name RESOURCE DESCRIPTION FilePackage This method validates the files, directories, and commands describing the contents to be included in the file package as specified by the fp_name argument. When a file package property such as the contents, an option, or an excluded file is changed, this method and the listed methods are invoked: fp_val_excludes fp_val_nestedlist fp_val_options fp_val_src_host The list of files, directories, or commands are provided through standard input, one per line. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments fp_name The name of the file package whose contents are validated Version 3.6

263 RETURNS Output Exit Codes The fp_val_flist method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. fp_val_flist Although you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_excludes, fp_val_nestedlist, fp_val_options, fp_val_src_host See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 51

264 fp_val_name NAME PURPOSE SYNOPSIS fp_val_name Validates the proposed name of a file package. fp_val_name fp_name new_name RESOURCE DESCRIPTION FilePackage This method validates the new name specified by the new_name argument given to the file package specified by the fp_name argument. This method is invoked when the file package is created or when the name of the file package is changed. Note that this method does not set the default name. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization senior or super Arguments fp_name new_name The name of the file package whose name was changed. The new name being validated. RETURNS Output The fp_val_name method writes these strings to standard output: TRUE Successful validation. FALSE Failed validation Version 3.6

265 Exit Codes fp_val_name Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 53

266 fp_val_nestedlist NAME PURPOSE SYNOPSIS fp_val_nestedlist Validates the nested file packages to be included in a file package. fp_val_nestedlist fp_name RESOURCE DESCRIPTION FilePackage This method validates the nested file packages to be included in the file package specified by the fp_name argument. Use this method to control the list of nested file packages for the file package. When a file package property such as the contents, an option, or an excluded file is changed, this method and these listed methods are invoked: fp_val_excludes fp_val_flist fp_val_options fp_val_src_host The list of nested file packages to be included is available to this method through standard input. Each file package to be nested is listed on a line by itself. If no file packages are to be nested, this list is empty. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments fp_name The name of the file package for which the nested file package to be included are validated Version 3.6

267 RETURNS Output Exit Codes fp_val_nestedlist The fp_val_nestedlist method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_excludes, fp_val_flist, fp_val_options, fp_val_src_host See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 55

268 fp_val_operation NAME PURPOSE SYNOPSIS fp_val_operation Validates the file package operations. fp_val_operation fp_name fp_operation RESOURCE DESCRIPTION FilePackage This method validates a file package operation, such as distribute, distribute and commit, commit, preview, or removal. It is called when a file package operation is attempted. The list of target managed nodes and PC managed nodes on which the operation will be performed is available to this method through standard input. Each managed node is listed on a line by itself. If validation is not successful, the operation will not occur. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Arguments fp_name fp_operation The name of the file package that is the subject of the operation being validated. The file package operation, modified by the distribution type, which determines what kind of distribution takes place (see the wdistfp command or the Distribution Options dialog box in the Distribute File Package dialog in the GUI). Distribution options only pertain to the DIST, DIST_AND_COMMIT 3 56 Version 3.6

269 fp_val_operation and PREVIEW file package operation options. The possible file package operations are: COMMIT DIST:ALL DIST:ANY_CHANGES DIST:SOURCE_CHANGES DIST_AND_COMMIT:ALL DIST_AND_COMMIT:ANY_CHANGES DIST_AND_COMMIT:SOURCE_CHANGES PREVIEW:ALL PREVIEW:ANY_CHANGES PREVIEW:SOURCE_CHANGES REMOVE RETURNS Output Exit Codes The fp_val_operation method writes these strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. Policy SEE ALSO wdistfp See Chapter 1, File Package Definitions for more information on file package definition format. TME 10 Software Distribution Reference Manual 3 57

270 fp_val_options NAME PURPOSE SYNOPSIS fp_val_options Validates file package options. fp_val_options fp_name RESOURCE DESCRIPTION FilePackage This method validates the options that are set for the file package. When a file package property such as the contents, an option, or an excluded file is changed, this method and these listed methods are invoked: fp_val_excludes fp_val_flist fp_val_nestedlist fp_val_src_host The list of options is available to the method through standard input, each listed on a line by itself in the format fp_keyword=value. Use this policy method, for example, to ensure that log files are created on certain managed nodes. You can also prevent distributions to certain targets or ensure that file packages are not removed using the fp_val_options method. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization senior or super 3 58 Version 3.6

271 fp_val_options Arguments fp_name The name of the file package whose options are validated. RETURNS Output Exit Codes The fp_val_options method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion. Use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_val_excludes, fp_val_flist, fp_val_nestedlist, fp_val_src_host See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 59

272 fp_val_src_host NAME PURPOSE SYNOPSIS fp_val_src_host Validates the proposed source host of a file package. fp_val_src_host fp_name src_host RESOURCE DESCRIPTION FilePackage This method validates the new source host specified by the src_host argument for the file package specified by fp_name. It is called when the source host for a file package is changed. When a file package property such as the contents, an option, or an excluded file is changed, this method and these listed methods are invoked: fp_val_excludes fp_val_flist fp_val_nestedlist fp_val_options Use this method, for example, to enforce a restriction that a certain file package must have a specific host as its source host. This method must have an exit status of 0 and write TRUE to standard output. Otherwise, validation is considered unsuccessful. Authorization admin, senior, or super Argument fp_name src_host The file package name whose source host was changed. The name of the managed node being validated Version 3.6

273 RETURNS Output Exit Codes fp_val_src_host The fp_val_src_host method writes the following strings to standard output: TRUE Successful validation. FALSE Failed validation. Though you can specify any exit code in your policy methods, Tivoli recommends that you use the following codes: E_OK E_USAGE E_FAIL Successful completion.use E_OK even if the output is FALSE; this exit code indicates that the policy method ran successfully. The method encountered an illegal option, argument, or parameter. The method failed due to an error. SEE ALSO fp_def_src_host, fp_val_delete_src_host, fp_val_excludes, fp_val_flist, fp_val_nestedlist, fp_val_options See Chapter 1, File Package Definitions for more information on file package definition format. Policy TME 10 Software Distribution Reference Manual 3 61

274 fp_val_src_host 3 62 Version 3.6

275 4 4Configuration Programs Configuration Programs Deploying client/server application software often involves more than simply distributing files and directories to target machines. Frequently, the application requires configuration, which can be as simple as supplying a license key or as complex as stopping and restarting the server daemon to change the database schema. TME 10 Software Distribution enables you to specify configuration programs that are run at various points during file package operations. These programs run either on the source host or on the client system before or after a file package distribution. Specifically, you can run a configuration program before a distribution on the source host or target, after a distribution on the source host or target, before and after removing a file package on the target, upon commit of the file package on the target, or if an error stops a distribution or removal operation. For a file package, you can specify multiple configuration programs for each target (and platform-type). Specify target configuration programs using the desktop, command line, or with the export and import capability. Specify source before or after programs using only the command line or the export and import capability. See the TME 10 Software Distribution User s Guide for detailed information about setting source and target configuration programs. This chapter discusses how the program arguments and input files are processed, and describes limitations of programs written for NetWare systems (NLMs). It also provides many example programs to assist you in your file package operation. TME 10 Software Distribution Reference Manual 4 1

276 Processing Command Line Arguments Processing Command Line Arguments When Software Distribution runs a configuration program, it passes command line arguments to the program to specify the file package operation in progress. These command line arguments enable you to designate, for example, the same program as both the before and after program. This program is created to accomplish different things depending on whether it is run before or after a distribution. Software Distribution passes command line arguments to configuration programs in the same way that commands invoked from the command line are passed their arguments. Currently, Software Distribution passes the following parameters to a configuration program: A literal string describing the configuration program type. The path to the input file, as specified in the yyy_xxx_input_path keywords. If an input file is not specified, a NULL literal string is passed. A literal string value of the ams_inst_sw_comp_handle keyword. This keyword specifies the AMS Installed Software Component Handle, which identifies the installed software component handle that is created for the software component by the Tivoli Developer s Toolkit. For more information about this keyword, see the manual page for the wsetfpopts command in Chapter 2, Commands.. If a value is not specified for this keyword, a NULL literal string is passed. For example, if you set the following keywords in a file package description: unix_after_prog_path= /tmp/user_conf_prog.sh unix_after_input_path= /tmp/user_conf_prog.in ams_inst_sw_comp_handle= Software Distribution will spawn an after configuration program with the following arguments: /tmp/user_conf_prog.sh after /tmp/user_conf_prog.in NULL It is possible that in future releases Tivoli will add other parameters to Software Distribution configuration programs. Therefore, Tivoli strongly recommends that configuration programs not perform a check 4 2 Version 3.6

277 Processing Input Files for the exact number of parameters that are passed. If you need to check for missing arguments in a configuration program, Tivoli recommends the following script: if [ $# -lt 3 ]; then echo Missing arguments exit 1 fi Processing Input Files Because you can specify multiple configuration programs of the same type, you can also specify multiple input files, separated by commas. The programs and input files are processed in the order in which you specify them. If a program does not require an input file but subsequent programs do, you must specify the input files in the correct order and preceded by the same number of commas as the programs. When the source or target configuration programs run on UNIX machines, the input files (if specified) are processed as standard input. Because standard input is handled differently across PC platforms, target configuration programs that run on a DOS, NetWare, OS/2, Windows, Windows 95, or Windows NT platform do not receive the input files as standard input. Rather, the programs receive the path to the input file as a second command line argument, as described in the previous section. Configuration Programs Return Codes of Configuration Programs Software Distribution writes the return status of each configuration program to the log file specified by the Log Information Options section of the File Package Properties window. This return status as reported in the log file is not the same as the exit status of the program. UNIX Configuration Programs For configuration programs run from a UNIX host, the return status written to the log file is reported according to the semantics of the wait system call. These semantics can vary depending on the architecture type of the host (source or target) from which a configuration program TME 10 Software Distribution Reference Manual 4 3

278 Return Codes of Configuration Programs is running, as specified by the src_program_prog_path and unix_ program_prog_path keywords. For example, if the log file states: script complete: status=400 and the source host were an HP machine, the exit status of the program would be 4 if the src_program_prog_path keyword was set. See the system documentation of the source host for information on the wait system call. NetWare Configuration Programs To specify configuration programs for NetWare targets, you must develop NetWare loadable modules (NLMs). However, because of technical limitations in the NetWare NLM software developer s kit (SDK), you cannot pass a return code from a child NLM to its parent. To remedy this problem, the PC agent exports a symbol that refers to a function call within the agent. This function sets the return code with the agent before it returns. The following code example shows the prototype for the SetErrorCode function: int SetErrorCode (int error_code); To avoid compiler warnings, include the SetErrorCode prototype in the source file from which it is called. The following code fragment shows how to integrate the function into an NLM: #include int SetErrorCode (int error_code);... main () { int ec;... return (SetErrorCode(ec)); } 4 4 Version 3.6

279 PC Environment Space After you modify the NLM to call the SetErrorCode function, you must link the NLM and use an import linker directive to resolve the symbol as follows: import SetErrorCode Note: Consult your compiler documentation for more information on how to use the import directive. If you specified an input file for one of the before, after, removal, or commit NLMs, you must open the specified input file as part of the NLM s processing. Configuration Programs PC Configuration Programs For.EXE,.COM, and.cmd configuration programs run on PCs, return codes other than 0 (indicate successful completion) are reported according to those included in the ERROR.TIV file in the TEMP directory. If the configuration program is a.bat file, you must use the wseterr command to return an error code. See Chapter 2, Commands for information on the wseterr command. PC Environment Space When a configuration program runs on a PC, it can exhaust the environment space if the program sets environment variables. Suppose, for example, the configuration program sets the TEMP, TZ, MOUSE, and PATH variables and invokes the MYCMD command (resides in the \TOOLS\BIN directory), as follows: set TEMP=C:\TEMP set TZ=CST6CDT set MOUSE=C:\MOUSE set PATH=%PATH%;C:\TOOLS\BIN;C:\WORD\EXCEL MYCMD -i TOOLS\BIN -d c exit 0 When the program runs, it sets the TEMP and TZ variables then runs out of environment space. Hence, the MOUSE and PATH variables are not set. When the program then tries to run the MYCMD command, it cannot because the PATH variable is not set correctly. TME 10 Software Distribution Reference Manual 4 5

280 UNIX Example Scripts If a program cannot find a command, you can specify the full path to the command. Thus, in the previous program, you could specify C:\TOOLS\BIN\MYCMD instead of simply MYCMD. You can also increase the environment space by editing the following line in the CONFIG.SYS file: SHELL=C:\COMMAND.COM C:\ /P /E:1536 where /E:1536 reserves 1536 bytes for environment space. UNIX Example Scripts Use the following Bourne shell scripts to reboot a target after a distribution, remove files from a destination directory, and change the permissions of a log file. Although these are Bourne shell scripts, you can implement configuration programs as Perl scripts, Korn shell scripts, or compiled executables. These example scripts are available by using anonymous ftp from ftp.tivoli.com. Connect to the ftp.tivoli.com site to access scripts in the /pub/support/courier/2.5 directory. The README.txt file in this directory describes which file corresponds to which example. If you are unfamiliar with anonymous ftp or do not have Internet access, contact your Tivoli support provider for a copy of the programs. Rebooting After a File Package Distribution Use the following script as a target after program to reboot a target after a file package is successfully distributed. Because the distribution must successfully complete, you cannot reboot the machine immediately after the distribution. You must schedule the reboot to allow the file package distribution to finish. Also, if you enable the Stop distribution on error option (the stop_on_error keyword) of the file package, this program will not run on a target, unless the distribution was completely successful. If you create this script and name it /usr/bin/reboot_bfr.sh, you can specify it for the GNU Emacs file package as follows: wsetfpprgs -T unix -a Emacs" 4 6 Version 3.6

281 UNIX Example Scripts This script requires root permissions so that it can submit UNIX at jobs. Root must not be listed in the /usr/lib/cron/at.deny file. Also, the unix_before_as_uid keyword must not be set so that this after program runs as root, thereby allowing the odadmin call to succeed. #!/bin/sh echo "/etc/reboot now >/dev/null 2>&1" at now + 5 minutes >/dev/null 2>&1 exit 0 Note: Consult your system documentation for information about the reboot command, such as where it resides and its valid arguments. This script will run on SunOS machines (the reboot command resides in the /etc directory). Configuration Programs Removing Files from the Destination Directory Use the following target before program to remove everything in a directory to which an application will be distributed. This script is useful if you want to ensure that the destination directory of a distribution is completely empty and nothing remains from a previous distribution. This script also ensures that the components of the path to the destination directory are available and that the path is not / (root). Thus, if you created this before program on the target and named it /usr/bin/before.sh, you can specify it for the GNU Emacs file package using the following wsetfpprgs command: wsetfpprgs -T unix -b Emacs" This before program assumes that the prog_env keyword is set as follows. If so, the components of the path should be available through the environment variables set by Software Distribution. prog_env="default_dir=$default_dest \ unix_dest_dir=$unix_platform_prefix" You must set the prog_env keyword for the GNU Emacs file package by using export/import or the wsetfpopts command. wsetfpopts -T gen -E \ "unix_dest_dir="\$"unix_platform_prefix \ Emacs" TME 10 Software Distribution Reference Manual 4 7

282 UNIX Example Scripts Create the script as follows: #!/bin/sh DEST_DIR=$unix_dest_dir/$default_dir cd $DEST_DIR CWD=`pwd` if [ "$CWD" = "/" ] then # # The destination is the root directory! # Do not want to remove everything under here. # exit 1 fi # # Remove the old version of the application to be # distributed. A file package removal performed on the file # package for the previous version should remove everything. # However,remove everthing as a safeguard in case someone # forgot to do that. # cd.. rm -rf $DEST_DIR exit 0 Running an Installation Script After a Distribution Use the following Bourne shell script as a UNIX after program that runs the installation script provided with the application in a file package. If you create this script and name it /usr/bin/install_aft.sh, you can specify it for the GNU Emacs file package using the following command: wsetfpprgs -T unix -a Emacs" Because the installation script is distributed with the file package, this program runs the script directly from the destination directory. For this program to function correctly, the prog_env keyword of the file package must define the following: The U_PATH variable, which is the UNIX platform prefix defined for the file package The D_PATH variable, which is the default destination defined for the file package 4 8 Version 3.6

283 UNIX Example Scripts The SERVER environment variable, which is set to the host name of the machine where the application server is running. Therefore, use the following command to set the prog_env keyword for the file package: wsetfpopts -T gen -E "U_PATH="\$"unix_platform_prefix \ D_PATH="\$"default_dest Create the script as follows: Configuration Programs #!/bin/sh # Set the name of the installation script. According to # TME 10 Software Distribution behavior, the installation # path is constructed by combining the "platform prefix" (if # set) with the "default destination" (if set). # APPINST=$U_PATH/$D_PATH/bin/appinst.sh # The application installation script takes one command # argument which is the hostname of the application server. # This is passed as the only argument upon invocation. The # script is also interactive, expecting answers to the # following questions: # # 1) What is the full path where the application has been # installed? # 2) Is this an upgrade from a previous release? [y or n] # 3) Should a full or partial install be performed? [full or # partial] # 4) Should the application daemon be started automatically # upon system reboot? [y or n] # # The correct answers are provided by a "shell here # document" specified in this script. # $APPINST $SERVER << app_after_script $D_PATH n full n app_after_script exit $? Checking the Architecture Type Use the following Bourne shell script as a UNIX before program to verify that a target managed node is a valid architecture type for the file package. If so, the program exits 0 and the distribution continues. If TME 10 Software Distribution Reference Manual 4 9

284 UNIX Example Scripts not, it exits non-zero and the distribution is not performed. For this to function correctly, the following file package properties must be set: The unix_before_skip_non_zero keyword is set to y. The prog_env keyword must define the TARGET environment variable as the TME 10 interpreter type of the valid architectures for the file package. See the TME 10 Framework Planning and Installation Guide for a current list of supported interpreter types for this release. The unix_before_as_uid keyword must not be set so that this before program runs as root, thereby allowing the odadmin call to succeed. To set the prog_env keyword, use the following wsetfpopts command to set the TARGET variable for an HP-UX 10.0 machine: wsetfpopts -T gen -E If you create this script and name it /usr/bin/charch_bfr.sh, use the following wsetfpprgs command to specify it for the example_fp file package: wsetfpprgs -T unix -b Create the script as follows: #!/bin/sh PATH=/bin:/usr/bin:$PATH export PATH ARCH=`odadmin grep "Interpreter type" awk '{print \$NF}'` if [ x"$arch" = x"$target" ] ; then exit 0 else echo "The interpreter type for this client ($ARCH) does not match $TARGET" >&2 exit 1 fi 4 10 Version 3.6

285 PC Example Programs PC Example Programs The following batch files check environment space, disk space, and prepare a Windows NT machine for a file package distribution. PC configuration programs can be written as.com,.bat,or.exe files. You can also write.cmd files for OS/2 targets and you must write NLMs for NetWare targets. Note: Because end-of-line markers in text files differ on UNIX and PC platforms and TME 10 Software Distribution does not translate data contained in distributed files, files (configuration programs) distributed from a UNIX source host to a target must contain end-of-line markers appropriate for the target. Therefore, if you create text files intended for a PC target on a UNIX machine, you must manually insert PC end-of-line markers at the end of each line in the files. The end-of-line marker on UNIX machines is the newline character (ASCII code 0x0a). The end-of-line marker on PC platforms is the carriage return character (ASCII code 0x0d) followed by the newline character. These example scripts are available by using anonymous ftp from ftp.tivoli.com. Connect to the ftp.tivoli.com site to access scripts in the /pub/support/courier/2.5 directory. The README.txt file in this directory describes which file corresponds to which example. If you are unfamiliar with anonymous ftp or do not have Internet access, contact your Tivoli support provider for a copy of the programs. Configuration Programs Checking Disk Space Use this batch file as a before program to ensure that a system has enough disk space to install and configure an application. This program requires that you know how much space the software package requires (9 MB in this example). It also checks to see if the files already exist at the target. If you create the program and name it /temp/dskspace.bat, specify this program on a Windows machine as a target before program using the wsetfpprgs command. wsetfpprgs -T win -b TME 10 Software Distribution Reference Manual 4 11

286 PC Example Programs Create the program as follows: ECHO OFF REM REM Set variables REM REM Check space needed on hard disk. REM SPACE: usage is 10m for 10 megabytes, 10k for 10 kilobytes and REM 10g for gigabytes. REM set SPACE=9m REM REM DIR: Directory to examine (i.e. where the software REM package will be installed, such as... c:\config). REM set DIR=c:\config REM REM LOG: Log file location REM set LOG=c:\tivoli\config.log REM REM PATH: Path to the Tivoli command utilities REM set PATH=c:\tivoli\cli\win16;%PATH% REM REM Initialize Log File REM ECHO.>%LOG% ECHO Running Tivoli pre_check process on this machine for the OurCorp>>%LOG% ECHO software package>>%log% ECHO.>>%LOG% ECHO.>>%LOG% REM REM Check system for space on C drive REM If not enough room on C drive, error code = 3 REM wdskspc -s %SPACE% %DIR% if errorlevel 1 goto nospace goto goodend :nospace echo. >>%LOG% echo.>>%log% echo There is not enough space on the hard drive>>%log% echo to install the OurCorp software.>>%log% echo Please make more space available on this machine.>>%log% echo.>>%log wseterr 3 goto end :goodend REM REM Set exit code to 0 REM wseterr 0 goto end :end 4 12 Version 3.6

287 PC Example Programs Preparing a Windows NT Target Before a Distribution You can use this program to prepare a target for installation of a software package. The program performs the following on each target: Ensures the target is running the Windows NT operating system Deletes a file on the target that was placed there to reserve disk space Ensures that the target has sufficient disk space Kills programs that are running and are part of the distribution If you create the following program on the source host and name it /tmp/prepare.exe, you can specify it as a target before program using the wsetfpprgs command. For example, if the file package for which you want to run this program is called Customer Serv Sys, you can specify the program as follows: Configuration Programs wsetfpprgs -T src -b Serv Sys" Also, to use this program, you must define the DEV_APPS, DIR_ARCH_UTILS, DIR_CLI, DIR_CSS_RESERVE, NEWSEED_DSKSPACE, and environment variables in Windows NT. Create the program as off REM ****************************************************** REM ** Set up error codes and environment variables REM ****************************************************** copy %2 c:\errcodes.bat >nul call c:\errcodes.bat set SCRIPT_ERROR_CODE=%ERROR_NONE% REM ****************************************************** REM ** Validate Operating System REM ****************************************************** if %DEBUG%==TRUE echo *** Checking Operating System. \ >c:\temp\debug.out if not %SystemRoot%x==x goto NTdetected if %DEBUG%==TRUE echo *** Unknown Operating System \ >>c:\temp\debug.out set SCRIPT_ERROR_CODE=%ERROR_INVALID_OS% goto end REM ****************************************************** REM ** Validate Disk Space - wdskspc always returns the REM ** number of bytes available on the specified device. TME 10 Software Distribution Reference Manual 4 13

288 PC Example Programs REM ** If the -s parameter is specified, then wseterr sets REM ** errorlevel to 1. We detect that and return a 6 to REM ** indicate not enough space. REM ****************************************************** :NTdetected if %DEBUG%==TRUE echo *** Operating System Verified \ >>c:\temp\debug.out REM ****************************************************** REM ** Determine if this is a CSS Update or a New CSS Seed REM ** with wgetval. If wgetval does not detect the NT REM ** registry entry for SOFTWARE\FPC\CSS\Tivoli, the REM ** ERRORLEVEL is 1 and this is a new seed. REM ****************************************************** %DIR_CLI%\wgetval -k "SOFTWARE\CSS\Tivoli" -n Version if ERRORLEVEL 1 goto NewSeed goto UpdateSeed REM ****************************************************** REM ** NewSeed REM ** If the machine has never received the software REM ** before, we are checking for the availability of 150mb REM ****************************************************** :NewSeed REM ** unprotect CSSSPACE.001 and delete it if %DEBUG%==TRUE echo *** New CSS Seed Required >>c:\temp\debug.out if not exist %DIR_CSS_RESERVE% goto NewSeedDiskSpaceCheck if %DEBUG%==TRUE echo *** Deleting Place Holder >>c:\temp\debug.out %SYSTEM_WIN32%\attrib -r -h %DIR_CSS_RESERVE% del %DIR_CSS_RESERVE% :NewSeedDiskSpaceCheck if %DEBUG%==TRUE echo *** Checking Disk Space. >>c:\temp\debug.out %DIR_CLI%\wdskspc -s %NEWSEED_DSKSPACE% %DRV_APPS% if %DEBUG%==TRUE echo *** Bytes available. >>c:\temp\debug.out if not ERRORLEVEL 1 goto DiskSpaceVerified if %DEBUG%==TRUE echo *** Inadequate Disk Space >>c:\temp\debug.out set SCRIPT_ERROR_CODE=%ERROR_DISK_SPACE% goto end REM ****************************************************** REM ** UpdateSeed REM ** If the machine has received the software before, we REM ** are checking for the incremental space needed to REM ** apply the update. REM ****************************************************** :UpdateSeed REM ** Unprotect CSSSPACE.002 and delete it if %DEBUG%==TRUE echo *** CSS Update Required >>c:\temp\debug.out if not exist c:\dos\cssspace.* goto UpdateDiskSpaceCheck if %DEBUG%==TRUE echo *** Deleting Place Holder >>c:\temp\debug.out %SYSTEM_WIN32%\attrib -r -h c:\dos\cssspace.* del c:\dos\cssspace.* :UpdateDiskSpaceCheck if %DEBUG%==TRUE echo *** Checking Disk Space. >>c:\temp\debug.out %DIR_CLI%\wdskspc -s %CURR_INCR_DSKSPACE% %DRV_APPS% if %DEBUG%==TRUE echo *** Bytes available. >>c:\temp\debug.out if not ERRORLEVEL 1 goto DiskSpaceVerified if %DEBUG%==TRUE echo *** Inadequate Disk Space >>c:\temp\debug.out set SCRIPT_ERROR_CODE=%ERROR_DISK_SPACE% goto end REM ****************************************************** REM ** Kill CSS specific processes - Call KILL.EXE to REM ** terminate any processess that might interfere with 4 14 Version 3.6

289 PC Example Programs REM ** the distribute. We are interested in any process that REM ** begins with: REM ** CU* = CSS Applications REM ** KT* = FOUNDATION 2.4 Runtime REM ** AZ* = Architecture REM ** CSR = Architecture Client/Service requestor REM ****************************************************** :DiskSpaceVerified if %DEBUG%==TRUE echo *** Adequate Disk Space >>c:\temp\debug.out if not exist %DIR_ARCH_UTILS%\wkill.exe goto killerr %DIR_ARCH_UTILS%\wkill CU* %DIR_ARCH_UTILS%\wkill CSR %DIR_ARCH_UTILS%\wkill AZ* %DIR_ARCH_UTILS%\wkill KT* Configuration Programs REM ****************************************************** REM ** Kill Failed REM ****************************************************** :killerr if %DEBUG%==TRUE echo *** Kill of Active Processes Failed \ >>c:\temp\debug.out set SCRIPT_ERROR_CODE=%ERROR_KILL_FAILED% goto end REM ****************************************************** REM ** Wrap Up REM ****************************************************** :end if %DEBUG%==TRUE echo *** %1 Script Complete, Error Code: %SCRIPT_ERROR_CODE% >>c:\temp\debug.out if %DEBUG%==TRUE echo *** Release %RELEASE_VERSION% Before \ Script Complete >>c:\temp\debug.out %DIR_CLI%\wseterr %SCRIPT_ERROR_CODE% Configuring Distributed PC Software Use this batch file as a commit program to configure the software product (OurCorp in this example), as follows: Create and add icons to the OurCorp group in Windows Add C:\ourcorp to the path in the AUTOEXEC.BAT file Add set statements to the AUTOEXEC.BAT file This batch file expects a file called C:\OURCORP\IL.INI to exist and contain the statements to be added to the Windows INI file. If you create the program and name it /usr/bin/config.bat, specify this program as a target commit program on a Windows machine using the wsetfpprgs command on the source host command line. wsetfpprgs -T win -c TME 10 Software Distribution Reference Manual 4 15

290 PC Example Programs Create the program as follows: ECHO OFF REM REM Error codes: REM 1 = could not add icons to OurCorp group REM 3 = could not add path statement to autoexec.bat REM 4 = could not add set statements to autoexec.bat REM 5 = could not add statements to win.ini REM REM Set variables for checking REM REM LOG: The log file location REM set LOG=c:\tivoli\ourcorp.log REM REM BAKDIR: The directory in which to store backup copies of REM system files we will modify. REM set BAKDIR=c:\tivoli\files.bak REM REM PATH: Path to the Tivoli utilities REM set PATH=c:\tivoli\cli\win16;%PATH% REM REM Initialize Log File REM ECHO.>>%LOG% ECHO ======================================================>>%LOG% ECHO.>>%LOG% ECHO Running Tivoli post_check process on this machine for the \ OurCorp>>%LOG% ECHO software>>%log% ECHO.>>%LOG% ECHO.>>%LOG% REM REM Add a new group and icons to windows REM Group: "OurCorp" REM Icons: Prism, Pivot, Readme and Test program REM ECHO.>>%LOG% ECHO Removing OurCorp Group if it exists >>%LOG% ECHO.>>%LOG% waddicon -g "OurCorp Apps" -r>>%log% ECHO.>>%LOG% ECHO Adding Icons and Group to windows >>%LOG% ECHO.>>%LOG% REM REM Add Information Catalog Icon. The group, OurCorp Applications, REM will be created automatically if it does not exist. REM ECHO Adding Information Cataloag>>%LOG% 4 16 Version 3.6

291 PC Example Programs waddicon -c j:\ourcorp\catalog\prod\ourcorp.exe -t "Information \ Catalog" -g "OurCorp Apps" >>%LOG% REM REM Add BrioQuery icon to the OurCorp Group. REM ECHO Adding BrioQuery icon to the OurCorp Applications Group>>%LOG% waddicon -g "OurCorp Apps" -c c:\ourcorp\exe\brioqry.exe -t \ "BrioQuery Explorer">>%LOG% REM REM Back up system files before modifying them REM echo Backing up system files before modifying them>>%log% mkdir c:\tivoli\files.bak echo Making backup copies of files>>%log% copy c:\windows\win.ini %BAKDIR%\win.inf copy c:\config.sys %BAKDIR%\config.inf Configuration Programs REM REM Update the win.ini file REM echo Adding the OurCorp text to the win.ini file >>%LOG% wmrgini c:\windows\win.ini c:\ourcorp\il.ini del c:\ourcorp\il.ini REM REM Update the autoexec.bat file with the following: REM set nd_path=c:\ourcorp\oi\lib REM set brioqry=c:\ourcorp\query REM SET Path=c:\ourcorp\exe;%PATH% REM ECHO.>>%LOG% ECHO.>>%LOG% echo Updating the autoexec.bat file >>%LOG% REM REM First, make a backup of the original. REM copy c:\autoexec.bat c:\autoexec.bkp :delprism find /i /c "SET PRISM=" c:\autoexec.bkp >>%LOG% if errorlevel 1 goto noprism ECHO.>>%LOG% ECHO PRISM already set in autoexec. Deleting...>>%LOG% ECHO.>>%LOG% wclrline -s "set prism=" -o c:\autoexec.ina c:\autoexec.bkp >> \ %LOG% :noprism ECHO UPDATING AUTOEXEC.BAT>>%LOG% find /i /c "SET PATH=c:\ourcorp\exe;%%PATH%%" \ c:\autoexec.ina>>%log% if errorlevel 1 goto nospath goto msg :nospath find /i /c ";c:\ourcorp\exe" c:\autoexec.ina>>%log% if errorlevel 1 goto noipath goto msg :noipath find /i /c "=c:\ourcorp\exe;" c:\autoexec.ina>>%log% if errorlevel 1 goto nopath :msg TME 10 Software Distribution Reference Manual 4 17

292 PC Example Programs ECHO.>>%LOG% ECHO Path already updated...skipping>>%log% ECHO.>>%LOG% goto ndpath :nopath ECHO Adding "SET PATH" line>>%log% winsline -f -s "c:\dos;" -a "SET PATH=c:\ourcorp\exe;%%PATH%%" \ -o c:\autoexec.inb c:\autoexec.ina >>%LOG% :ndpath if not exist c:\autoexec.inb copy c:\autoexec.ina c:\autoexec.inb find /i /c "SET ND_PATH=c:\ourcorp\oi\lib" c:\autoexec.inb>>%log% if errorlevel 1 goto nondpath ECHO.>>%LOG% ECHO ND_PATH already updated...skipping>>%log% ECHO.>>%LOG% goto brioqry :nondpath ECHO Adding "ND_PATH" line>>%log% winsline -f -s "c:\dos;" -a "SET ND_PATH=c:\ourcorp\oi\lib" -o \ c:\autoexec.inc c:\autoexec.inb >>%LOG% :brioqry if not exist c:\autoexec.inc copy c:\autoexec.inb c:\autoexec.inc find /i /c "SET BRIOQRY=c:\ourcorp\query" c:\autoexec.inc>>%log% if errorlevel 1 goto nobrio ECHO.>>%LOG% ECHO BrioQry already updated...skipping>>%log% ECHO.>>%LOG% ECHO Coping autoexec.inc to autoexec.bat...>>%log% copy c:\autoexec.inc c:\autoexec.bat goto config :nobrio ECHO Adding "BrioQry" line>>%log% winsline -f -s "c:\dos;" -a "SET BrioQry=c:\ourcorp\query" -o \ c:\autoexec.bat c:\autoexec.inc >>%LOG% REM ============================================================== REM Updating the config.sys file with the following: REM Files=50 REM :config ECHO.>>%LOG% ECHO.>>%LOG% REM Updating the config.sys file echo Updating the config.sys file >> %LOG% find /i /c "FILES=50" c:\config.sys>>%log% if errorlevel 1 goto nofiles ECHO.>>%LOG% ECHO FILES=50 already updated...skipping>>%log% ECHO.>>%LOG% goto chkfiles :nofiles find /i /c "FILES=" c:\config.sys>>%log% if errorlevel 1 goto setfiles ECHO.>>%LOG% ECHO FILES= already there, updating..>>%log% ECHO.>>%LOG% ECHO Updating "Files=" line>>%log% wrplline -f -s "files=" -o c:\config.out -r "files=50" \ c:\config.sys copy c:\config.out c:\config.sys 4 18 Version 3.6

293 goto chkfiles :setfiles echo Updating Config.sys>>%LOG% echo FILES=50>>c:\config.sys :chkfiles PC Example Programs REM ============================================================= REM Checking for existance of old files and then deleting them. REM Files: REM briodbs.prf REM prism.ini REM brio.ini REM pivot.ini REM REM REM Checking for briodbs.prf Configuration Programs ECHO.>>%LOG% ECHO Checking for c:\windows\briodbs.prf..>>%log% ECHO.>>%LOG% IF NOT EXIST C:\WINDOWS\BRIODBS.PRF GOTO CHKPRISM ECHO c:\windows\briodbs.prf exists. Deleting...>>%LOG% DEL C:\WINDOWS\BRIODBS.PRF :chkprism REM Checking for prism.ini ECHO.>>%LOG% ECHO Checking for c:\windows\prism.ini..>>%log% ECHO.>>%LOG% IF NOT EXIST C:\WINDOWS\prism.ini GOTO CHKBRIO ECHO c:\windows\prism.ini exists. Deleting...>>%LOG% DEL C:\WINDOWS\prism.ini :chkbrio REM Checking for brio.ini ECHO.>>%LOG% ECHO Checking for c:\windows\brio.ini...>>%log% ECHO.>>%LOG% IF NOT EXIST C:\WINDOWS\BRIO.ini GOTO CHKpivot ECHO c:\windows\brio.ini exists. Deleting...>>%LOG% DEL C:\WINDOWS\BRIO.ini :chkpivot REM Checking for pivot.ini ECHO.>>%LOG% ECHO Checking for c:\windows\pivot.ini..>>%log% ECHO.>>%LOG% IF NOT EXIST C:\WINDOWS\pivot.ini GOTO done ECHO c:\windows\pivot.ini exists. Deleting...>>%LOG% DEL C:\WINDOWS\pivot.ini :done REM ECHO DELETING OLD FILES >>%LOG% REM TME 10 Software Distribution Reference Manual 4 19

294 PC Example Programs del c:\config.out>>%log% DEL c:\autoexec.inz >>%LOG% DEL c:\autoexec.ina >>%LOG% DEL c:\autoexec.inb >>%LOG% DEL c:\autoexec.inc >>%LOG% REM DONE 4 20 Version 3.6

295 5 5Customizations This chapter describes how to customize TME 10 Software Distribution with TME 10 Application Extension Facility and TME 10 Application Development Environment. Using the Application Extension Facility, you can add gadgets to a dialog, create attributes and methods for the FilePackage and AutoPack resources, and create custom icons and bitmaps. Using the Application Development Environment, you can programmatically change the functionality of the methods for the FilePackage, AutoPack, ManagedNode, PcManagedNode, default policy, and validation policy resources. Before using either application, you should be familiar with the information presented in the TME 10 Application Extension Facility User s Guide and the TME 10 Application Development Environment documentation. Customizations TME 10 Application Extension Facility TME 10 Application Extension Facility provides a way for you to add attributes and gadgets to the file package and AutoPack dialogs, as well as other TME 10 resources. This chapter discusses customizing only TME 10 Software Distribution. See the TME 10 Application Extension Facility User s Guide for information about customizing other TME 10 applications and resources. You must have Application Extension Facility installed in your TME 10 environment before attempting to use the Application Extension Facility commands or before performing any of the following actions. TME 10 Software Distribution Reference Manual 5 1

296 TME 10 Application Extension Facility Retrieving Dialog Descriptors Dialogs and windows are stored as binary dialog descriptors, which are generated by the DSL compiler. DSL is a compiled language that enables you to specify, compile, and install dialogs within an application. When you customize a Software Distribution dialog or window, you create a new version of the dialog descriptor. You must then install the new dialog descriptor for the resource. The following table lists the descriptors available with the Software Distribution FilePackage resource. You can list these descriptor names using the wlsdialog r FilePackage command. Descriptor Name confirm2 confirm3 distribute_filepack netware_rights optional_info options_dos options_netware options_nt options_os2 options_unix options_windows options_win95 properties_filepack remove_filepack Dialog or Window Export File Package Confirmation dialog Overwrite File Confirmation dialog Select Source Host dialog Use Defaults Confirmation dialog File Package Close dialog Distribute File Package dialog Add NetWare Server Trustee Rights dialog Edit Optional Information dialog File Package MS/DOS Options dialog File Package NetWare Options dialog File Package Windows NT Options dialog File Package OS/2 Options dialog File Package UNIX Options dialog File Package Windows Options dialog File Package Windows 95 Options dialog File Package Properties window Remove File Package dialog 5 2 Version 3.6

297 TME 10 Application Extension Facility Descriptor Name select_fps Dialog or Window Select File Packages dialog The following table lists the descriptors available with the Software Distribution AutoPack resource. You can list these descriptor names using the wlsdialog r AutoPack command. Descriptor Name calc_size Dialog or Window Calculate AutoPack Size dialog dist_ap props_ap remove_ap Distribute AutoPack dialog Set AutoPack Properties dialog Remove AutoPack dialog All other dialog descriptors are inherited from the TME 10 Framework. To customize a dialog, you must perform the following actions: Retrieve the dialog descriptor Reverse-compile the descriptor Edit the DSL source code Compile the new dialog descriptor Install the custom descriptor To customize Software Distribution, you must use the FilePackage or AutoPack resource type. For more information on dialog descriptors, see the TME 10 Application Extension Facility User s Guide. Customizations Changing Existing Dialog Gadgets You can modify fields, check boxes, and radio buttons on the Software Distribution dialogs. To do so, you must retrieve, de-compile, modify, re-compile, and install the DSL code for the selected dialog. The following examples provide scenarios and solutions for changing or TME 10 Software Distribution Reference Manual 5 3

298 TME 10 Application Extension Facility disabling existing dialog gadgets. Use these steps as an example for customizing either the FilePackage or AutoPack resource s dialogs. Note: If you have a window displayed while you customize it, you will not see your changes until you close the window for at least a minute (to allow the daemon to time out). Suppose you set the Software Distribution default policy such that the Perform compression on distribution option is enabled for all newly-created file packages, and you set the Software Distribution validation policy so that a user cannot disable this option. Because the Perform compression on distribution option can no longer be set by the user, you can modify the File Package Properties window so that this option is not available. Also, suppose you want to change the Vendor field on the Edit Optional Information dialog to the Author field. To implement these desired changes, complete the following steps: 1. Using the wgetdialog command, retrieve the File Package Properties window s and the Edit Optional Information dialog s dialog descriptor by entering the following commands: wgetdialog -r FilePackage properties_filepack \ > /tmp/properties.d wgetdialog -r FilePackage optional_info \ > /tmp/optional.d where: r FilePackage Specifies to retrieve the dialog descriptor for the FilePackage resource type. properties_filepack and optional_info Specifies to retrieve the dialog descriptor file. > /tmp/properties.d and > /tmp/optional.d Redirects the output of the command to the specified file. If you do not redirect the output to another process or file, the output is sent to standard output. 5 4 Version 3.6

299 TME 10 Application Extension Facility 2. To reverse compile the each dialog descriptor, enter the following rdsl commands: rdsl /tmp/properties.d > /tmp/properties.dsl rdsl /tmp/optional.d > /tmp/optional.dsl where: /tmp/properties.d and /tmp/optional.d Specifies to reverse-compile the dialog descriptor file. > /tmp/properties.dsl Redirects the output of the reverse compiler to the /tmp/properties.dsl and /tmp/optional.dsl files. If you do not redirect the output to another process or file, output is sent to standard output. 3. Edit the /tmp/properties.dsl file to disable the Perform compression on distribution option on the File Package Properties window. a. Locate the following code in the /tmp/properties.dsl file: Customizations Switch { Changed = CB_DoCompress_switch&(), CB_PropsDirty&(); Name = DoCompressSwitch; Title = Msg(FpDsl, Perform compression on distribution,339); TitlePos = RIGHT; Value = $do_compress; ChildColumnAlignment = LEFT; } b. To desensitize the Perform compression on distribution option, insert the following line at the bottom of this section of code: Sensitive = NO; TME 10 Software Distribution Reference Manual 5 5

300 TME 10 Application Extension Facility Thus, the resulting code is: Switch { Changed = CB_DoCompress_switch&(), CB_PropsDirty&(); Name = DoCompressSwitch; Title = Msg(FpDsl, Perform compression on distribution,339); TitlePos = RIGHT; Value = $do_compress; ChildColumnAlignment = LEFT; Sensitive = NO; } c. Save and exit the /tmp/properties.dsl file. 4. Edit the /tmp/optional.dsl file to change the Vendor field on the Edit Optional Information dialog. a. Locate the following code in the /tmp/optional.dsl file: Message { Name = vendor_title; Title = Msg(FpDsl, Vendor:,11); GridHorizontal = 0; GridVertical = 4; ChildColumnAlignment = LEFT; ChildRowAlignment = CENTER; } b. Change the code so that the title of the field is Author, as follows: Message { Name = vendor_title; Title = Msg(FpDsl, Author:,11); GridHorizontal = 0; GridVertical = 4; ChildColumnAlignment = LEFT; ChildRowAlignment = CENTER; } Note: If you are using TME 10 in a language other than English, you must also change the catalog name and message key in the Msg(FpDsl, Author:, 11) message directive or change the entry number 11 in 5 6 Version 3.6

301 TME 10 Application Extension Facility all translated versions of the FpDsl message catalog. See the TME 10 Application Extension Facility User s Guide for more information about message catalogs. c. Save and exit the /tmp/optional.dsl file. 5. Compile the DSL code for each file by entering the following dsl commands: dsl /tmp/properties.dsl > /tmp/properties.d dsl /tmp/optional.dsl > /tmp/optional.d where: /tmp/properties.dsl and /tmp/optional.dsl Specifies to compile the /tmp/properties.dsl and /tmp/optional.dsl files. > /tmp/properties.d and > /tmp/optional.d Redirects the compiled output to the /tmp/properties.d and /tmp/optional.d files, respectively. If you do not redirect the output to another process or file, it is sent to standard output. 6. Install the changes to the File Package Properties window and Edit Optional Information dialog by entering the following wputdialog commands: Customizations wputdialog -r FilePackage -T properties_filepack < /tmp/properties.d wputdialog -r FilePackage -T optional_info < /tmp/optional.d where: r FilePackage Specifies the FilePackage resource type for which to install the dialog. T Installs the dialog in all connected TMRs. properties_filepack and optional_info Sets the properties_filepack and optional_info dialog descriptors. TME 10 Software Distribution Reference Manual 5 7

302 TME 10 Application Extension Facility < /tmp/properties.d and < /tmp/optional.d Redirects the new code from the modified DSL files, /tmp/properties.d and /tmp/optional.d.if you do not redirect a file to this command, the command reads from standard input. The command line displays the following message to indicate that the change is successful: Adding resource-wide customization for dialog properties_filepack and resource FilePackage. 7. View the changes to the File Package Properties window by double-clicking of a file package icon This radio button is now desensitized 5 8 Version 3.6

303 TME 10 Application Extension Facility To view the Edit Optional Information dialog, select Optional Information... from the Edit menu on the File Package Properties window: This field is now titled Author Customizations Exposing File Package Keywords and Excluded Files TME 10 Software Distribution file packages support keywords that are not currently available from the desktop. Use the TME 10 Application Extension Facility to add new gadgets to any of the Software Distribution dialogs so that you can set these keywords from the desktop. The type of gadget you can add to a dialog depends on the type of keyword you want to expose. In addition to exposing keywords, you can expose the list of excluded files. The file package definition is comprised of a header and four sections keyword options, files and directories to be distributed, nested file packages, and files to be excluded from the file package. All of these sections are available from the desktop except the excluded files list. Use the Application Extension Facility to expose this list as TME 10 Software Distribution Reference Manual 5 9

304 TME 10 Application Extension Facility a List gadget (like the Source Directories and File and Nested File Packages scrolling lists on the File Package Properties window). The following tables list the keywords and their gadget types. Implement the boolean keywords as Switch or Choice gadgets; the UID, GID, time, and file mode keywords as Text gadgets; the reboot/restart keywords as Choice gadgets; and the string keywords as Text, Page, or Choice gadgets. See the TME 10 Application Extension Facility User s Guide for descriptions and illustrations of the gadget types. Boolean Keywords create_dirs do_compress dos_after_removal_input_from_src dos_before_input_from_src dos_on_error_input_from_src dos_removal_input_from_src install_progs no_overwrite nt_after_removal_input_from_src nt_before_input_from_src nt_on_error_input_from_src nt_removal_input_from_src nw_after_removal_input_from_src nw_before_input_from_src nw_on_error_input_from_src nw_removal_input_from_src do_checksum dos_after_input_from_src dos_after_removal_prog_from_src dos_commit_input_from_src dos_on_error_prog_from_src file_cksums nested_first nt_after_input_from_src nt_after_removal_prog_from_src nt_commit_input_from_src nt_on_error_prog_from_src nw_after_input_from_src nw_after_removal_prog_from_src nw_commit_input_from_src nw_on_error_prog_from_src os2_after_input_from_src 5 10 Version 3.6

305 TME 10 Application Extension Facility Boolean Keywords os2_after_removal_input_from_src os2_before_input_from_src os2_on_error_input_from_src os2_removal_input_from_src rm_extraneous src_before_skip_non_zero os2_after_removal_prog_from_src os2_commit_input_from_src os2_on_error_prog_from_src rm_empty_dirs skip_older_src unix_after_input_from_src unix_after_removal_input_from_src unix_before_input_from_src unix_on_error_input_from_src unix_removal_input_from_src win95_after_removal_input_from_src unix_after_removal_prog_from_src unix_commit_input_from_src unix_on_error_prog_from_src win95_after_input_from_src win95_after_removal_prog_from_src Customizations win95_before_input_from_src win95_on_error_input_from_src win95_removal_input_from_src win_after_removal_input_from_src win_before_input_from_src win_on_error_input_from_src win_removal_input_from_src win95_commit_input_from_src win95_on_error_prog_from_src win_after_input_from_src win_after_removal_prog_from_src win_commit_input_from_src win_on_error_prog_from_src UID Keywords log_file_uid src_before_as_uid unix_after_removal_as_uid src_after_as_uid unix_after_as_uid unix_before_as_uid TME 10 Software Distribution Reference Manual 5 11

306 TME 10 Application Extension Facility UID Keywords unix_commitas_uid unix_on_error_as_uid unix_default_dir_uid unix_removal_as_uid GID Keywords log_file_gid unix_default_dir_gid Time Keywords default_mtime File Mode Keywords default_dir_mode log_file_mode Restart/Reboot Keywords dos_after_removal_option nt_after_removal_option win95_after_removal_option win_after_removal_option dos_on_error_option nt_on_error_option win95_on_error_option win_on_error_option String Keywords backup_fmt default_dest 5 12 Version 3.6

307 TME 10 Application Extension Facility String Keywords dos_after_removal_input_path dos_on_error_input_path list_path nt_after_removal_prog_path nt_on_error_prog_path nw_after_removal_prog_path dos_after_removal_prog_path dos_on_error_prog_path nt_after_removal_input_path nt_on_error_input_path nw_after_removal_input_path nw_on_error_input_path nw_on_error_prog_path os2_after_removal_prog_path os2_on_error_prog_path preproc src_after_input_path os2_after_removal_input_path os2_on_error_input_path postproc prog_env src_after_prog_path Customizations src_before_input_path src_relpath unix_after_removal_prog_path unix_on_error_prog_path win95_after_removal_prog_path win95_on_error_prog_path win_after_removal_prog_path win_on_error_prog_path src_before_prog_path unix_after_removal_input_path unix_on_error_input_path win95_after_removal_input_path win95_on_error_input_path win_after_removal_input_path win_on_error_input_path The following examples provide steps that you can follow to create each type of gadget. Note that if you have the dialog displayed while you perform this customization, you will not see the changes until you close the dialog for at least a minute (to allow the daemon to time out). TME 10 Software Distribution Reference Manual 5 13

308 TME 10 Application Extension Facility Creating a Switch Gadget and the Excluded Files List Suppose you want to make the nested_first keyword (a boolean keyword) and excluded files list available in the File Package Properties window. Implement the nested_first keyword as a Switch gadget in the General Options section of the window, and implement the excluded files list as a List gadget. 1. Retrieve the File Package Properties window s dialog descriptor using the wgetdialog command: wgetdialog -r FilePackage properties_filepack \ rdsl > /tmp/filepack.dsl where: r FilePackage Specifies to retrieve the dialog descriptor for the FilePackage resource type. properties_filepack Specifies to retrieve the properties_filepack dialog descriptor file. rdsl Redirects the output of the wgetdialog command to the rdsl command, which reverse-compiles the code. > /tmp/filepack.dsl Redirects the output of the rdsl command to the /tmp/filepack.dsl file. If you do not redirect the output to another process or file, the output is sent to standard output. 2. Edit the /tmp/filepack.dsl file to make the nested_first keyword available. a. Add a Switch gadget for the nested_first keyword. Locate the following code in the file: Switch { Changed = CB_DoCompress_switch&(), CB_PropsDirty&(); Name = DoCompressSwitch; 5 14 Version 3.6

309 TME 10 Application Extension Facility Title = Msg(FpDsl, Perform compression on distribution,339); TitlePos = RIGHT; Value = $do_compress; ChildColumnAlignment = LEFT; } To add a Process nested file packages first option below the Perform compression on distribution option, insert the following code below this section of code: Switch { Name = NestedFirstSwitch; Title = Process nested file packages first ; TitlePos = RIGHT; ChildColumnAlignment = LEFT; } When defining the Switch gadget, you need only define the Name, Title, TitlePos, and Alignment attributes. b. Add the following variable definition in the variable declaration section (at the top) of the filepack.dsl file: Customizations CString IgnoredValue = register_fp_keyword% ( properties_filepack, nested_first, /.../NestedFirstSwitch ); where: IgnoredValue Assigns the value returned by the register_fp_keyword method to the IgnoredValue variable, which is ignored. properties_filepack Specifies the dialog to be modified. nested_first Specifies the nested_first keyword in the file package definition. /.../NestedFirstSwitch Specifies the path to the gadget to be created. TME 10 Software Distribution Reference Manual 5 15

310 TME 10 Application Extension Facility If you were to add another gadget to the dialog, you would simply add the keyword and the new gadget s name, such as install_progs, to this declaration, as follows: CString IgnoredValue = register_fp_keyword% ( properties_filepack, nested_first, /.../NestedFirstSwitch, install_progs, /.../SecondKeywordSwitch ); 3. Add the exclude files list. Locate the following code in the /tmp/filepack.dsl file: } Group { Attributes { Border = YES; Layout = VERTICAL; Name = fpoptionsgroup; ChildColumnAlignment = CENTER; ChildRowAlignment = STRETCH; } } Insert the following code above this section of code: Group ExcludeFilesDirsGroup = Load( excludes ); Note: You can add this line of code anywhere in the DSL file, which will determine its position on the window. In this case, the exclude files list is added in the Group gadget that defines the source files list and nested file packages list. 4. Save the file and compile the DSL code by entering the following dsl command: dsl /tmp/filepack.dsl > /tmp/filepack.d where: /tmp/filepack.dsl Specifies to compile the /tmp/filepack.dsl file Version 3.6

311 TME 10 Application Extension Facility > /tmp/filepack.d Redirects the compiled output to the /tmp/filepack.d file. If you do not redirect the output to another process or file, it is sent to standard output. 5. Install the dialog by entering the following wputdialog command: wputdialog -r FilePackage properties_filepack \ < /tmp/filepack.d where: r FilePackage Specifies the FilePackage resource type for which to install the dialog. properties_filepack Sets the properties_filepack dialog descriptor. < /tmp/filepack.d Redirects the new code from the /tmp/filepack.d file. If you do not redirect a file to this command, the command reads from standard input. Customizations TME 10 Software Distribution Reference Manual 5 17

312 TME 10 Application Extension Facility 6. View the changes to the File Package Properties window by double-clicking of a file package icon: Creating a Choice and Text Gadget Currently, Software Distribution file packages do not support after removal and on error keywords from the desktop. Suppose you wanted to expose the after removal keywords, creating another configuration button on each platform-specific file package dialog. For example, you would create an After Removal button on the File Package Windows Options dialog to expose the win_after_removal_prog_from_src, 5 18 Version 3.6

313 TME 10 Application Extension Facility win_after_removal_prog_path, win_after_removal_input_from_src, win_after_removal_input_path, and win_after_removal_options keywords. Note: This procedure is complicated; Tivoli recommends that you be very familiar with the Application Extension Facility and DSLs before performing this procedure. Complete the following steps to add after removal keywords to the platform-specific dialogs: 1. Retrieve the File Package Window Options dialog s dialog descriptor using the wgetdialog command: wgetdialog -r FilePackage options_windows \ rdsl > /tmp/opts_win.dsl where: r FilePackage Specifies to retrieve the dialog descriptor for the FilePackage resource type. options_windows Specifies to retrieve the options_windows dialog descriptor file. rdsl Redirects the output of the wgetdialog command to the rdsl command, which reverse-compiles the code. > /tmp/opts_win.dsl Redirects the output of the rdsl command to the /tmp/opts_win.dsl file. 2. Locate the following code in the /tmp/opts_win.dsl file. Customizations Button { Commands = set_visible&/globalgroup/scriptgroup/ BeforeScriptGroup(NO), set_visible&/globalgroup/ ScriptGroup/AfterScriptGroup(NO), set_visible&/ GlobalGroup/ScriptGroup/RemoveScriptGroup(NO), set_visible&/globalgroup/scriptgroup/ CommitScriptGroup(YES); Name = CommitButton; TME 10 Software Distribution Reference Manual 5 19

314 TME 10 Application Extension Facility Title = Msg(FpDsl, During Commit,239); TitlePos = CENTER; GridHorizontal = 1; GridVertical = 3; ChildColumnAlignment = STRETCH; ChildRowAlignment = CENTER; } 3. Copy this text and insert it below itself. Modify the gadget definition so that it is as follows: Button { Commands = set_visible&/globalgroup/scriptgroup/ BeforeScriptGroup(NO), set_visible&/ GlobalGroup/ScriptGroup/AfterScriptGroup(NO), set_visible&/globalgroup/scriptgroup/ RemoveScriptGroup(NO), set_visible&/ GlobalGroup/ScriptGroup/CommitScriptGroup(NO), set_visible&/globalgroup/scriptgroup/ AfterRemovalScriptGroup(YES); Title = After Removal ; TitlePos = CENTER; GridHorizontal = 1; GridVertical = 4; ChildColumnAlignment = STRETCH; ChildRowAlignment = CENTER; } This step creates the After Removal button, which will display the partial dialog where the after removal keywords are exposed. Because you are adding another button, you must indicate that you ll have five buttons on the dialog, not four. Locate the following line: GridHeight = 4; Change 4 to 5 in this line of code. 4. Add the following line at the end of the Commands attribute for each configuration program Button gadget (similar to the code in step 3): set_visible&/globalgroup/scriptgroup/ AfterRemovalScriptGroup(NO); 5 20 Version 3.6

315 Thus, the code in step 3 will be: TME 10 Application Extension Facility Button { Commands = set_visible&/globalgroup/scriptgroup/ BeforeScriptGroup(NO), set_visible&/globalgroup/ ScriptGroup/AfterScriptGroup(NO), set_visible&/ GlobalGroup/ScriptGroup/RemoveScriptGroup(NO), set_visible&/globalgroup/scriptgroup/ CommitScriptGroup(YES), set_visible&/globalgroup/ ScriptGroup/AfterRemovalScriptGroup(NO); Name = CommitButton; Title = Msg(FpDsl, During Commit,239); TitlePos = CENTER; GridHorizontal = 1; GridVertical = 3; ChildColumnAlignment = STRETCH; ChildRowAlignment = CENTER; } 5. Locate the following code: Group { Attributes Customizations { Border = YES; Layout = VERTICAL; Name = CommitScriptGroup; Title = Msg(FpDsl, Commit Distribution BAT/EXE/COM File Options,267); TitlePos = TOP;..(omitted code). Choice { Changed = CB_OptionsWindowsDirty&(); } } } } Choices = Msg(FpDsl, Do nothing,274){opt_none}, Msg(FpDsl, Reboot machine,275){opt_reboot}, Msg(FpDsl, Restart Windows,276){OPT_RESTART}; Name = BootChoice; Show = ALL; Sort = NO; Title = Msg(FpDsl, After Commit:,273); TitlePos = TOP; Value = $win_commit_option; ChildColumnAlignment = LEFT; } TME 10 Software Distribution Reference Manual 5 21

316 TME 10 Application Extension Facility 6. Copy this code and insert it below itself. Make the following changes to the code. This addition to the DSL file enable you to specify whether the input file resides on the source host or subscriber (set the win_after_removal_input_from_src keyword). By default, this keyword is set to the same value as the win_after_removal_prog_from_src keyword. The final code should look like the following: Group { Attributes { Border = YES; Layout = VERTICAL; Name = AfterRemovalScriptGroup; Title = After Removal Distribution BAT/EXE/COM File Options ; TitlePos = TOP; Visible = NO; GridHorizoontal = 0; GridVertial = 1; ChildRowAlignment = STRETCH; } Gadgets { Choice { Border = YES; Choices = Msg(FpDsl, Source Host,269){ y }, Msg(FpDsl,Subscribers,270){ n }; Layout = HORIZONTAL; Name = win_after_removal_prog_from_src; Show = ALL; Sort = NO; Title = Msg(FpDsl, Get BAT/EXEC/COM file from:,268); TitlePos = TOP; ChildColumnAlignment = STRETCH; } Group { Attributes { Border = YES; Layout = HORIZONTAL; Name = prog_group; Title = Msg(FpDsl, Enter BAT/EXE/COM file name,271); TitlePos = TOP; } 5 22 Version 3.6

317 TME 10 Application Extension Facility } Gadgets { Text { Name = win_after_removal_prog_path; ChildColumnAlignment = STRETCH; } } Choice { Border = YES; Choices = Msg(FpDsl, Source Host,269){ y }, Msg(FpDsl,Subscribers,270){ n }; Layout = HORIZONTAL; Name = win_after_removal_input_from_src; Show = ALL; Sort = NO; Title = Msg(FpDsl, Get input file from:,268); TitlePos = TOP; ChildColumnAlignment = STRETCH; } Group { Attributes Customizations } { Border = YES; Layout = HORIZONTAL; Name = input_group; Title = Msg(FpDsl, Enter input file name,271); TitlePos = TOP; } Gadgets { Text { Name = win_after_removal_input_path; ChildColumnAlignment = STRETCH; } } Choice win_after_removal_option = Load( advanced_win_opt, title, After Removal Script Runs: ); } } TME 10 Software Distribution Reference Manual 5 23

318 TME 10 Application Extension Facility 7. Add the following variable to the Variable block: CString dummy = register_fp_keyword%( options_windows, win_after_removal_prog_from_src, /.../win_after_removal_prog_from_src, win_after_removal_prog_path, /.../win_after_removal_prog_path, win_after_removal_input_from_src, /.../win_after_removal_input_from_src, win_after_removal_input_path, /.../win_after_removal_input_path, win_after_removal_option, /.../win_after_removal_option ); 8. Save the file and compile the DSL code by entering the following dsl command: dsl /tmp/opts_win.dsl > /tmp/opts_win.d where: /tmp/opts_win.dsl Specifies to compile the /tmp/opts_win.dsl file. > /tmp/opts_win.d Redirects the compiled output to the /tmp/opts_win.d file. If you do not redirect the output to another process or file, it is sent to standard output. 9. Install the dialog by entering the following wputdialog command: wputdialog -r FilePackage -T options_windows \ < /tmp/opts_win.d where: r FilePackage Specifies the FilePackage resource type for which to install the dialog. T Installs the dialog in all connected TMRs. options_windows Sets the options_windows dialog descriptor Version 3.6

319 TME 10 Application Extension Facility < /tmp/opts_win.d Redirects the new code from the /tmp/opts_win.d file. If you do not redirect a file to this command, the command reads from standard input. 10. View the changes to the File Package Windows Options dialog by selecting Platform-Specific Options -> Windows Options... from the Edit menu of the File Package Properties window: Customizations TME 10 Software Distribution Reference Manual 5 25