Latest ApplyPTF #: QO88994
Last Updated: June 12, 2007
General Information
The Applyptf utility allows you to apply and/or
list PTFs on your system or master install image. You may either
work interactively with the Applyptf Wizard on NT, or invoke it
from the command line with arguments that specify the actions you
wish it to perform. Working interactively with the Applyptf Wizard
is the easiest method of applying fixes. Whenever any information
has been omitted, or decisions from you are required, the Applyptf
Wizard will prompt you as necessary. Applyptf can:
- List the
PTFs applied to the local or a remote node
- List the
PTFs applied to a master install image
- Apply a
PTF to the local or a remote node
- Apply a
PTF to a master install image
- Batch
apply any set of PTFs to nodes and/or master install images
(NT)
- Batch
apply any set of PTFs to local unix machines
- Apply a
PTF to a master image on UNIX
Notes before continuing with this document:
-
Throughout this document references to Unicenter TNG are used in
the examples to explain the various Applyptf features or
functionality. This in no way shape or form implies this utility is
specific to Unicenter TNG.
- The
document makes mention of a master image. A master image is a disk
copy of the original product installation image. Applyptf supports
applying fixes to a products master installation image. Some
products do not support a master installation image. For those that
do not, any sections or references regarding master images can be
ignored.
- This
document refers to the location of the latest Applyptf. Please
note, any references to specific product requirements, Unicenter
TNG, AutoSys, etc.. in the fix documentation will apply to that
mentioned product only and can be ignored for all other
products.
When applying PTFs to your current product
installations, you should always use Applyptf.
Applyptf eliminates common PTF application
problems:
* Verifies prerequisite PTFs have already been
installed
Applyptf scans through the node's "history file",
a log that lists what PTFs have been applied (and when) by this
application. If no such log exists it offers to create one and will
name it "<nodename>.his".
More information on history files is included
later in this document.
* Compares the file dates in the PTF with those
already on the target
Applyptf compares the date stamp of all
"replacement" files in the PTF with those already on the system. It
will not replace a file if it detects that the new file is older
than its installed counterpart.
* Backs up the original files in case you need to
remove the PTF
Applyptf creates a directory tree
"REPLACED\PTFNAME.OLD" on NT, and "REPLACED\PTNFAME" on Unix, in
the target component/image directory. For example, for a Unicenter
TNG Worldview fix it may create "c:\tngwv\replaced\lo76563.old".
For a master install image it may create
"c:\tngimage\replaced\ lo76563.old". It then
copies all original files that will be replaced to this directory.
It will not overwrite any file already in this directory, thus not
overwriting any originals if the file is replaced again in a later
PTF application.
* Maintains a PTF history file for each PTF
application target
Applyptf will update the target's history file
each time it applies a PTF to it.
* Seamlessly performs all of the above actions
from a single node
The Applyptf Wizard can be run from any Windows
NT node. There is a Unix version of Applyptf as well.
Be sure to review the installation instructions
included with each PTF ---before--- using Applyptf to apply
a fix to any system. (Some fixes may contain instructions about
steps that need to be completed before or after a fix is
applied.)
Applyptf Wizard Platform Specific
Considerations and Requirements
Windows NT and Windows 2000
The Applyptf Wizard requires the following for
Windows NT:
- Account
authorized to query the registry on local and/or remote
node(s).
- An
existing share of the remote Windows NT node component
directory.
The share can
be readable if you plan only to list the PTFs applied to that node.
The share must be write-enabled if you plan to apply a PTF to that
node. For example, if you plan to apply a Unicenter TNG Worldview
PTF to a remote node, there must exist a write-enabled share of the
installation directory (typically C:\TNGWV in this case) on the
remote node. You need not map this to a drive letter on your
system. (If you already share the parent directory of the component
directory, you don't need to share the component directory
again).
- A
"history" file will be created in this share directory listing what
PTFs have been applied. One is created for each component, and it
is always created on the target when connecting to Windows NT.
- If
applying a ptf to a Master Image, cazip.exe and cazipxp.exe must
exist on your machine, in a directory that is part of the path
statement.
Applyptf Wizard Instructions
All Unicenter TNG Services and processes on any
NT target node(s) should be stopped prior to applying any
PTF.
Please be sure to review the installation
instructions included with each PTF before using
Applyptf to apply a fix to any system. (Some fixes may contain
instructions about steps that need to be completed before or after
a fix is applied.)
You may either work interactively with the
Applyptf Wizard, or invoke applyptf.exe from the command line with
arguments that specify the actions you wish it to perform. The node
name for "List the PTFs applied to the local or a remote node" and
"Apply a PTF to the local or a remote node" will be default to
local machine.
Working interactively with the Applyptf Wizard is
the easiest method of applying fixes. Whenever any information has
been omitted, or decisions from you are required, the Applyptf
Wizard will prompt you as necessary.
Applyptf History File
The first time the Applyptf Wizard is asked to
work with a node, it will state that it can not find a "history"
file for that node and may ask if you wish to create it. Such files
are always named "<nodename>.his", where nodename is the node
you specified. It is generally wise to use nodenames rather than IP
addresses if at all possible. For Windows NT and UNIX, the history
file is stored in the root product directory. For AS/400, the
history file is saved in the main product library, which by default
is CAUNIOBJ. (You could get a large and confusing set of
a.b.c.d.his files on your machine, so we recommend using the node
names.)
IMPORTANT: Since you can use the Applyptf Wizard
from any node to apply to any other node, you may create multiple
history files on multiple machines for the same target node! In
this event you should manually merge the files so as to keep an
accurate log. This is a relatively simple task because the history
log is an ASCII text file, thus you can just cut and paste multiple
logs together. You can also choose to apply from only one client
node and one PTF directory, in which case this will no longer be a
concern.
Applyptf Command Line Instructions
(NT)
Use applyptf /? to display the usage and version
information.
You may invoke Applyptf via the command line.
Call applyptf.exe and use any of the following options:
/PTF=c:\path\to\ptfname.jcl
or
/PTF=c:\path\to\ptfname.caz
/NODE=nodename
/MASTER=c:\path\to\root\image\directory
/LIST=nodename
/LIST=PATH:c:\path\to\unix\history\file.his
/MASTERLIST=c:\path\to\root\image\directory
/OUTPUTFILE=c:\path\and\name\of\output\file
/FILE=c:\path\to\command\file
/SILENT
/CREATEHISTORY
/INSTALLNEW
/USERNAME=userid_to_ftp_to_remote_node
/PASSWORD=password_for_ftp_userid
/DEBUGFILE=c:\path\and\name\of\debug\file
/CONFIRMBYPASS
/NEWRELEASE (NetWare TNGEM and TNGAT
only)
Description:
1. /PTF
This specifies the full path name to the
PTFNAME.JCL or PTFNAME.CAZ file.
If the .CAZ file is specified, Applyptf will
unzip the file (using CAZIPXP) into where ever %TMP is set to on
the local machine.
Syntax:
/PTF=c:\path\to\ptfname.jcl
or
/PTF=c:\path\to\ptfname.caz
2. /NODE
This or /MASTER must be specified if the previous option
(/PTF) was used. It can be either a nodename or an IP address. Be
aware that using IP addresses can cause confusion. See the section
below regarding the Applyptf history file.
Syntax:
/NODE=nodename
3. /MASTER
This specifies the full path to the directory
which contains the root of the copied CD. (For Unicenter TNG, this
is the location of the setup.exe file.) The CD-ROM image must have
been copied to some form of writeable media for PTF application to
be successful. Also, cazip.exe and cazipxp.exe must exist on your
machine somewhere in the path.
Syntax:
/MASTER=c:\path\to\root\image\directory
4. /LIST
This specifies the nodename for which you wish to
view the applied PTFs (i.e. view the history file). This is only
valid for Windows NT nodes, and may also be a nodename or IP
address (see item 2).
Syntax:
LIST=nodename
5. /LIST=PATH:
Unix and AS/400 history files are stored on the
local machine. This field specifies the full path to the history
file you wish to view.
Syntax:
/LIST=PATH:c:\path\to\unix\history\file.his
6. /MASTERLIST
The history file for master install images is
kept in the root directory of the install image (the directory
containing the TNG setup.exe). This field specifies the full path
of this directory.
Syntax:
/MASTERLIST=c:\path\to\root\image\directory
7. /OUTPUTFILE
Specifies the full path and name of a file where
all screen output will be sent.
** THIS WILL APPEND INFO TO ANY FILE THAT ALREADY
EXISTS BY THIS NAME **
Syntax:
/OUTPUTFILE=c:\path\and\name\of\output\file
8. /FILE
Users wishing to batch apply a set of PTFs to a
set of nodes or images may do so by using a text file containing
the desired commands. See the next section for more details.
Syntax:
/FILE=c:\path\to\command\file
9. /SILENT
This option is only valid when used in
conjunction with the /FILE option. See the next section for details
of the /SILENT option. If /SILENT is specified, /OUTPUTFILE is
required.
Syntax:
/SILENT
10. /CREATEHISTORY
If this option is specified, and a history file
does not exist yet, APPLYPTF will create the history file without
prompting the user. Without this option, the user will be asked if
he wants to create the history file.
Syntax:
/CREATEHISTORY
11. /INSTALLNEW
If this option is specified, and a ptf with a new
file is applied, APPLYPTF will apply the fix without prompting the
user.
Syntax:
/INSTALLNEW
12. /USERNAME=userid_for_ftp_to_remote_node
This option is only valid for application of a
ptf to a UNIX node. The specified userid will be used for ftp'ing
the ptf to the remote node.
Syntax:
/USERNAME=userid_to_ftp_to_remote_node
13. /PASSWORD=password_for_userid_for_ftp
This option is only valid for application of a
ptf to a UNIX node. The specified password will be used for ftp'ing
the ptf to the remote node.
Syntax:
/PASSWORD=password_for_ftp_userid
14. /DEBUGFILE
Specifies the full path and name of a file where
all debug information will be sent. This parameter is
optional.
** THIS WILL APPEND INFO TO ANY FILE THAT ALREADY
EXISTS BY THIS NAME **
Syntax:
/DEBUGFILE=c:\path\and\name\of\debug\file
15. /CONFIRMBYPASS
A message box will be displayed if it is checked
and the timestamp of the original file (on target machine) is newer
than the source file (file from the fix being applied).
Syntax:
/CONFIRMBYPASS
16. /NEWRELEASE (NetWare TNGEM and TNGAT
only)
If set, a PTF having newer release / genlevel
will be installed without questions asked. If both /SILENT and
/NEWRELEASE are set, only fixes having the exact same release and
genlevel as the installed products will be installed.
Syntax:
/NEWRELEASE (NetWare TNGEM and TNGAT
only)
Applyptf Batch Execution (NT)
As mentioned above, you may execute a set of /PTF
and /NODE or /MASTER or /BATCHCMD commands by using a text file,
and specifying the path to that file in the Applyptf Wizard, or on
the command line by typing:
applyptf.exe /FILE=c:\path\to\command\file
The command file may list the /PTF= /NODE=
specifications in any order regardless of operating system. Special
attention should be paid to prerequisite and co-requisite
definitions. The dependencies are defined in the .TXT file for each
fix, and the prerequisite checking is enforced via the JCL. Be sure
to apply those fixes that are prerequisites for others,
first.
Any system command should be specified after
/BATCHCMD=. It allows you to execute master pre and post
commands.
If any required specifications are omitted or if
there are problems during execution, the Applyptf Wizard will
prompt you with the relevant information. If the /SILENT command
line option is used, or if the "Non-interactive" check box is on in
the Applyptf Wizard, all interaction will be turned off, and any
requests that require user interaction will be skipped.
Note: Applyptf does not trap the result of any
SYSCMDs, PRESYSCMDs, or BATCHCMDs.
** Sample command file for execution by the
Applyptf Wizard: **
/PTF=c:\path\to\the\ptf.jcl /NODE=nodename
/PTF=c:\path\to\another\ptf.jcl /NODE=nodename
/USERNAME=id /PASSWORD=pw
/PTF=c:\path\to\another\ptf.jcl
/NORE=nodename
/PTF=c:\path\to\another\ptf.jcl
/MASTER=d:\root\directory\of\cdimage
/BATCHCMD=cd c:\temp
Note: Any valid path is acceptable, "c" and "d"
drives are just examples. ".caz" may also be specified, instead of
".jcl".
In the above example the first PTF may be for
Windows NT, in which case the current account must have registry
and share access if the node is remote, or sufficient local access
if the node is local. This is why no username/password is requested
or accepted if supplied, the current user account information is
used. If this were a Unix or AS/400 PTF then this line is missing
the username/password fields. If interactive the user will be
prompted for them, if /SILENT is on this whole request will be
ignored and an error will be issued for later review.
The second PTF could be for either Unix or
AS/400. For all such PTFs you -must- supply a valid FTP username
and password to the remote machine.
The third PTF is actually the same as the second,
but has a syntax error. It should be /NODE=, not /NORE=. An error
message will be issued and this PTF application will be
skipped.
Applying a ptf from NT to Unix without using the
Applyptf Wizard
applyptfunx.exe (NT)
This program is a socket client responsible for
sending the jcl and other fix files to the UNIX host, receiving the
progress messages from the host, and displaying the messages to the
user. The unix executable, applyptf, is started by applyptfunx.exe
via a rexec (remote execute) command.
syntax:
applyptfunx.exe /FILE='JCL file full path'
/NODE=host
/USERNAME='user id'
/PASSWORD='user password'
/ARCHIVE='the archive full path in unix'
(e.g.
/usr/tmp/tmpptf/).
[/KEEPARCHIVE=Y|N (default = N)]
[/GLOBALROOT=install_path_on_unix]
[/DEBUG=debug_file]
[/APPLYPTFPATH=location_of_applyptf_on_unix]
All arguments in the command line must be
specified, otherwise error will be returned. All progress message
will displayed on the stdout.
The program can be run as batch mode.
This program can be run from the command line, or
it can be accessed via the Applyptf.exe PTF Wizard. If run via the
Wizard, all progress messages, including the data in the history
file, will be displayed in the list box. If run from the command
line, data will be displayed on the screen.
NOTE: If applyptf.exe or applyptfunx.exe times
out when connecting to the UNIX machine, you may need to set the
timeout variable. The PTF_TIMEOUT environment variable can be set
on NT to increase the connection waiting time. By default it is
1500 milliseconds. If a longer waiting time is needed, please set
PTF_TIMEOUT first, then run applyptf.
For example,
set PTF_TIMEOUT=5000
will set the timeout value to 10000 milliseconds,
which is 10 seconds.
Master Install Images
A master install image is a disk copy of the
installation media. For NT, it is a copy of the NT install CD. For
Unix, it is a copy of the Unix tar file. A master install image can
be used to pre-apply maintenance prior to installing
software.
Considerations for Master Install Image on
NT:
To apply to a master image on NT, the full NT CD
image must have been copied to some form of writeable media for PTF
application to be successful. Also, cazip.exe and cazipxp.exe must
exist on your machine somewhere in the path.
JCL File explanation
PLATFORM: Operating system where the ptf is to
applied.
PRODUCT: Main product the ptf is for (TNGAT,
TNGEM, TNGSSO). This is used to determine where the files will
reside on the target machine.
VERSION: This line tells APPLYPTF to expect an
enhanced JCL file.
RELEASE: This line tells APPLYPTF for what
release of the PRODUCT: this ptf is written.
GENLEVEL: This line tells APPLYPTF for what
genlevel of the PRODUCT: this ptf is written.
PRESYSCMD: This line specifies a system command
that will be run before all files are replaced. This can be used to
run an update script that we ship. Variables may be used, however
these variables must already be set on the target machine. This
option is available for NT, Win95 and UNIX fixes.
PREREQS: This line specifies the prerequisite
ptfs that are needed. If the prerequisites are not found in the
history file, APPLYPTF will not allow the application of this ptf
to continue.
MPREREQS: This line specifies the prerequisites
needed if installing this fix to a master image. In most cases, the
ptfs specified as PREREQS will also be MPREREQS. Note: Currently,
MPREREQS is only valid for NT/NetWare/Win95 PTFS for certain TNG
products
FILE: This line specifies a file to be applied to
a standard install. This line supports keywords:
a) NEWFILE = this file is new, user will no
longer be prompted that the file could not be found on the target
system
b) CHMOD = the permission of the file will be set
to the value indicated (UNIX ONLY)
c) CHOWN = the owner of the file will be set to
the value indicated (UNIX ONLY)
d) CHGRP = the group of the file will be set to
the value indicated (UNIX ONLY)
e) SCRIPT = the file is a script. Special care is
taken when the file is transferred to the UNIX server, so that
CTL+M characters are removed (UNIX ONLY)
f) TARFLAG = this file is shipped inside of a
*.tar.Z file (UNIX ONLY see TARFILE: )
g) ABSPATH=xxx means this file is not installed
under the global product path, but rather to the absolute path
specified here. (UNIX ONLY)
h) TARGETNAME = this keyword specifies what the
name of the file will be on a installed image. If not specified,
the default name will be used
MFILE: This line specifies a file to be applied
to a master image. This line supports keywords:
a) NEWFILE = this file is new, user will not
longer be prompted that the file could not be found on the target
system
b) NOCAZIP = this file should be applied to the
master image as is, with no compression done
c) MASTERNAME = this keyword specifies what the
name of the file will be on a master image. if not specified, the
default is the change the last char of the regular name to
'_'
d) CAZIPXPINSERT = this file should be inserted
into the file specified with the MASTERNAME keyword, using
CAZIPXP.EXE The path into the .CAZ file can be specified as
CAZIXPINSERT=abc\efg\. Note: Currently, MFILE: is only valid for
NT/NetWare/Win95 PTFS for TNG 2.1 Proper. MFILE: is also valid for
Unix, but none of the keywords specified above can be used.
TARFILE: This line specifies a file that is of
the form *.tar.Z. This file contains one or more files to be
replaced on the target system (UNIX ONLY see TARFLAG: above) When
this file is created on a UNIX box, the contained files must exist
in the same directory structure that will be used on the target
machine. The path of the file inside the *.tar.Z file must be the
same path listed on the FILE: line
SYSCMD: This line specifies a system command that
will be run after all files are replaced. This can be used to run
an update script that we ship. Variables may be used, however these
variables must already be set on the target machine. This option is
available for NT, Win95 and UNIX fixes.
FTP File explanation
The FTP File (UNIX ONLY)
The FTP file is used when a UNIX ptf is applied
from NT. The FTP file tells APPLYPTF what files to transfer to the
UNIX box, and how. It has a similar format as the JCL file.
FAQs:
You can try to resolve the "cannot create socket"
error when applying a fix from NT to Unix by changing "telnet=0" to
"telnet=1" in applyptfunx.ini which can be found in the same folder
as applyptf.exe on NT
Download ApplyPTF