zVMFetch

The zVMFetch task retrieves a simple text or binary file from z/VM through PTF. The file is written to the work directory using the z/VM file name and file type for the file's name and extension respectively. For example: ./.work/zvmFilename.zvmFiletype.

The following table describes standard zVMFetch attributes.

Attribute Description Required
failOnError If the value is true (the default), the task fails if it encounters an error. If the value is false, some errors are ignored and the task is completed. No
failproperty Name of the ant property in which to store the result of the task. If the task is successful, the specified property will be set to true. If the task fails, the specified property will be set to false. If failOnError is set to true, this option has no effect. No
reportError If the value is true (the default) and failOnError is set to false, an informational message is written to the log when an error is encountered which includes the error message text. If the value is false, no message is written to the log when an error is encountered. If failOnError is set to true, this option has no effect. No
reportTrace If the value is true and reportError is true and failOnError is false, the stack trace for the error is written to the log. If the value is false (the default), the stack trace for the error is not written to the log. If failOnError is set to true, or if reportError is set to false, this option has no effect. No

The following table describes task specific attributes of zVMFetch.

Attribute Description Required
binaryFile If the value is true, a binary transfer is performed. If the value is false (the default), a text transfer is performed. No
deleteFile If the value is true, the z/OS file is deleted after the file is successfully transferred. If the value is false (the default), the z/OS file is not deleted. No
work The work directory for the zVMFetch build. The transferred file will be written to the work directory by zVMFetch. If this attribute is not specified, it will default to the ".work" sub-directory of the base directory. For example: if the base directory is C:\MyFolder\base\ the work directory will be C:\MyFolder\base\.work\. No
zvmCodePage Specifies the name of the z/VM FTP code page to use when retrieving a file. If a code page is not specified, the default code page is used. The default code page is locally defined on the specified z/VM system. No
zvmDisk Specifies the z/VM file name. Yes
zvmFiletype Specifies the z/VM file type. Yes
zvmHost Specifies the URL of the z/VM host. Yes
zvmPassword Specifies the encrypted password to use when logging onto the z/VM system. Yes
zvmUser Specifies the user ID for authentication to the z/VM system. Yes
Note: Encrypted passwords can be generated by the zVMPassword ant task or by the zImportGetPassword Java application. To generate an encrypted password with the zVMPassword task refer to the task's documentation. To generate an encrypted password with the zImportGetPassword Java application, issue the following command from a Windows command prompt window:
java -classpath path_to_jar\com.ibm.team.enterprise.smpe.build.scmutilities.jar 
com.ibm.team.enterprise.smpe.toolkit.internal.zimport.util.zImportGetPassword pw
substituting "path_to_jar" with the actual path to the jar file and "pw" with the actual password.

Example

Fetch a file

<?xml version="1.0" encoding="UTF-8"?> 
<project name="zVMFetch" default="main" xmlns:es="antlib:com.ibm.team.enterprise.smpe.toolkit">          

		<target name="main" description="main">         
					<es:zVMFetch             
								zvmDisk="191"             
								zvmFilename="PROFILE"             
								zvmFiletype="EXEC"             
								zvmHost="stlvm1.svl.ibm.com"             
								zvmPassword="-5e993fc4f3b23dd11502775ded3804a0"             
								zvmUser="DJREILLY"         
					/>     
		</target>      

</project>

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki