The task is used to retrieve a single text or binary file from z/VM^® via FTP. 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

Attributes

The task supports Build Extensions Debugging Attributes and Build Extensions General Attributes, as well as, its own task specific attributes. Click on a link for more information on the common attributes.

The following table describes the task specific attributes for the task:

Task Specific Attributes
Attribute	Description	Required
binaryFile	If `true`, a binary transfer is performed. If `false` (the default), a text transfer is performed.	No
deleteFile	If `true`, the z/VM file is deleted after the file is successfully transferred. If `false` (the default), the z/VM file is not deleted.	No
property	The name of the Ant property in which to return the path to the fetched file.	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 VDEV (virtual device address) for the disk that contains the file. This VDEV is associated with the specified zvmUser. An MDISK or LINK directory statement for the VDEV is required in the zvmUser’s directory entry.	Yes
zvmFilename	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

Notes

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.toolkit.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.

Examples

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>

getTaskNameHdr()

Attributes

Notes

Examples