Repository files navigation

A Node module to help Node.JS developers interacting with z/OS easily, taking advantage of z/OS FTP service.If z/OS FTP service is not configured as FTP over SSL, it's recommended to be deployed on z/OS, to avoid transferring user account/password in clear-text over network.Otherwise, the secure connection of FTP over SSL is recommended.IBM SDK for Node.js - z/OS is available athttps://developer.ibm.com/mainframe/products/ibm-sdk-for-node-js-z-os/.

For aZowe CLI plugin based on this functionality, seehttps://github.com/zowe/zowe-cli-ftp-plugin

npm install zos-node-accessor# Put latest version in your package.json

• List MVS dataset or USS files
• Download/Upload MVS dataset or USS files
• Submit JCL and query its status to track its completion
• Access SYSOUT dataset

zos-node-accessor is rewritten in TypeScript, and defines API methods in more consistent way. So some old API methods are renamed. Here are about some details useful when you migrate the code usingzos-node-accessor v1 to v2.

• listDataset(...) is renamed tolistDatasets(...)
• getDataset(...) is split and renamed todownloadFile anddownloadDataset(...)
• queryJob(...) returns the enum member ofJobStatusResult
• Job methods takes the query option object likeJobIdOption,JobLogOption, orJobListOption
• rename(...) is split and renamed torenameFile(...) andrenameDataset(...)
• delete(...) is split and renamed todeleteFile(...) anddeleteDataset(...)

Many list methods in v2 likelistDatasets(...) andlistFiles(...) returns the objects with the type likeDataSetEntry, instead of the key/value pairs in v1. To make the migration easier, you can enable migrationMode to havezos-node-accessor return the v1 key/value pairs, so that you can take time to change code to use the types object. This migration mode will be dropped in future. Let us know, if you have problem in removing the code using the key/value pairs.

    const zosAccessor = new ZosAccessor();    zosAccessor.setMigrationMode(true);    var connectionInfo = {        ....    };    await zosAccessor.connect(connectionInfo)

This accessor leverages z/OS FTP server to interact with z/OS. To work with z/OS JES better, it requiresJESINTERFACELevel set to2 on z/OS FTP settings.

• Connection
• MVS dataset
  • Allocate dataset
  • List datasets
  • List members of PDS dataset
  • Upload dataset
  • Download dataset
  • Delete dataset
  • Rename dataset
• USS file or directory
  • Make directory
  • List files
  • Upload file
  • Download file
  • Delete file
  • Rename file
• JES jobs
  • List jobs
  • Submit JCL
  • Query job status
  • Get job status
  • Get JES spool files
  • Delete job
• Others
  • Retrieve Server Status
  • Submit SITE commands

Before connecting to a z/OS server, you need to initialize an instance using the constructornew ZosAccessor(), then call theconnect(option: ConnectionOption) method, where:

• option -ConnectionOption - Configuration passed to the underlying ftp library.

ConnectionOption

• user -string - Username for authentication on z/OS.Default: 'anonymous'
• password -string - Password for authentication on z/OS.Default: 'anonymous@'
• host -string - The hostname or IP address of the z/OS server to connect to.Default: 'localhost'
• port -number - The port of the z/OS FTP server.Default: 21
• secure -boolean - Set to true for both control and data connection encryption.Default: false
• secureOptions -object - Additional options to be passed totls.connect().Default: (none)
• connTimeout -number - How long (in milliseconds) to wait for the control connection to be established.Default: 30000
• pasvTimeout -number - How long (in milliseconds) to wait for a PASV data connection to be established.Default: 30000
• keepalive -number - How often (in milliseconds) to send a 'dummy' (NOOP) command to keep the connection alive.Default: 10000

A promise that resolves itself (ZosAccessor object), and rejects on any error.

import{ZosAccessor}from'../zosAccessor';constaccessor=newZosAccessor();awaitaccessor.connect({user:'myname',password:'mypassword',host:'localhost',port:21,pasvTimeout:60000,secure:true,secureOptions:{ca:[caBuffer]}});

allocateDataset(datasetName: string, allocateParamsOrString?: string | AllocateParams) - Allocate sequential or partition (with the DCB attribut "PDSTYPE=PDS") dataset.

• datasetName -string - Dataset name to allocate.
• allocateParams -string | AllocateParams - A string of space separated DCB attributes or an object of DCB attribute key-value pairs, eg. "LRECL=80 RECFM=VB" or {"LRECL": 80, "RECFM": "VB"}. These attributes are transferred as FTPsite sub commands. The tested attributes includes BLKsize/BLOCKSIze, BLocks, CYlinders, Directory, LRecl, PDSTYPE, PRImary, RECfm, SECondary, and TRacks.

Note:DSORG=PO was defined by zos-node-accessor, notsite sub command. It's deprecated bysite sub command,PDSTYPE=PDS orPDSTYPE=PDSE.

Thesite sub commands can be found athttps://www.ibm.com/docs/en/zos/2.3.0?topic=subcommands-site-subcommandsend-site-specific-information-host.

A promise that resolves on success, rejects on error.

awaitconnection.allocateDataset('HLQ.ABC.DEF','LRECL=80 RECFM=FB BLKSIZE=320');

awaitconnection.allocateDataset('HLQ.ABC.PDS',{'LRECL':80,'RECFM':'FB','BLKSIZE':320,'PDSTYPE':'PDS','DIRECTORY':20});

listDatasets(dsn: string) - Lists the datasets whose names match with the given dataset name.

Note: This method is renamed fromlistDataset(dsnOrDir) in v1.0.x, to be consistent with the other list methods.

• dsn -string - Full qualified name of dataset, or dataset name with wildcards (* or ?)

A promise that resolves a list ofDatasetEntry.

DatasetEntry

• blockSize -number - Block size
• dsOrg -string - Dataset organization
• extends -number - How many extends
• name -string - Dataset name
• isMigrated -boolean - Is migrated or not. When migrated, many attributes like recordLength is unknown.
• recordFormat -string - Record format
• recordLength -number - Record length
• referred -string - Last referred date
• unit -string - Device unit
• usedTracks -number - Used tracks
• volume -string - Volume

awaitconnection.listDatasets('HQL.*.JCL');for(constentryoflist){console.log('name:',entry.name,'dsorg',entry.dsOrg);}

listMembers(partitionDsn: string) - Lists the members of partition dataset

• partitionDsn -string - Full qualified name of partition dataset

A promise that resolves a list ofDatasetMemberEntry.

DatasetMemberEntry

• changed -string - Changed date
• created -string - Created date
• name -string - Member name
• size -number - Size
• version -string - Version

uploadDataset(input: Input, destDataset: string, transferMode: TransferMode = TransferMode.ASCII, allocateParamsOrString?: string | AllocateParams) - Uploads data to the specified dataset on z/OS.

• input -Input - Input, which can be aReadableStream, aBuffer, or a path to a local file.
• destDataset -string - Name of the dataset to store the uploaded data.
• transferMode - TransferMode_ - Data transfer mode, either TransferMode.ASCII or TransferMode.BINARY.When transfering 'ascii' files, the end-of-line sequence of input should always be\r\n. Otherwise the transfered file will get truncated.
• allocateParamsOrString -string | AllocateParams - A string of space separated DCB attributes or an object of DCB attribute key-value pairs, eg. "LRECL=80 RECFM=VB" or {"LRECL": 80, "RECFM": "VB"}. The tested attributes: BLKsize/BLOCKSize, LRecl, RECfm, PRImary, SECondary, TRacks.

A promise that resolves on success, rejects on error.

import*asfsfrom'fs';constinput=fs.readFileSync('/etc/hosts','utf8').replace(/\r?\n/g,'\r\n');awaitconnection.uploadDataset(input,'HLQ.HOSTS');awaitconnection.uploadDataset(input,'HLQ.HOSTS',"LRECL=80 RECFM=FB");

downloadDataset(dsn: string, transferMode: TransferMode = TransferMode.ASCII, stream = false, siteParams?: string) - Downloads the specified dataset or member of patition dataset.

• dsn -string - Specify a full qualified dataset name, or USS file name. ItCAN NOT contain any wildcard (*).
• transferMode -TransferMode -TransferMode.ASCII,TransferMode.BINARY,TransferMode.ASCII_STRIP_EOL,TransferMode.ASCII_RDW,TransferMode.ASCII_NO_TRAILING_BLANKS, orTransferMode.BINARY_RDW. TheTransferMode.ASCII,TransferMode.ASCII_STRIP_EOL,TransferMode.ASCII_RDW, orTransferMode.ASCII_NO_TRAILING_BLANKS asks z/OS FTP service to convertEBCDIC characters toASCII. TheTransferMode.ASCII_STRIP_EOL asks z/OS FTP service not to append aCLRF to the end of each record. TheTransferMode.ASCII_NO_TRAILING_BLANKS asks z/OS FTP service to remove trailing blanks. TheTransferMode.ASCII_RDW orTransferMode.BINARY_RDW supports to download variable length dataset, which add 4-byte Record Description Word (RDW) at the beginning of each record.
• stream -boolean -true if you want to obtain aReadableStream of the data set content, orfalse to read a full dataset into memory (in Buffer). The buffer accepts up to 4MB data. For large dataset, usestream=true instead.
• siteParams -string - Add extra site parameters, for example, 'sbd=(IBM-1047,ISO8859-1)' for encoding setting.

A promise that resolves content of the dataset in eitherBuffer orReadableStream.

constjclBuffer=awaitconnection.downloadDataset('HQL.AA.JCL',TransferMode.ASCII);console.log('JCL is:');console.log(jclBuffer.toString());constjclStream=awaitconnection.downloadDataset('HQL.AA.JCL(MEMBER1)',TransferMode.ASCII,true);constwritable=fs.createWriteStream('file.txt');jclStream.pipe(writable);

deleteDataset(dsn) - Deletes the dataset or member of parition dataset whose names match with the given dataset name.

• dsn -string - Specify a full qualified dataset name to delete. ItCAN NOT contain a wildcard (*).

A promise that resolves on success, rejects on error.

awaitconnection.deleteDataset('HQL.AA.JCL');

renameDataset(dsn: string, newDsn string) - Renames dataset, member in partition dataset.

• dsn -string - Old dataset name.
• newDsn -string - New dataset name to rename to.

A promise that resolves on success, rejects on error.

awaitconnection.renameDataset('HQL.AA.JCL','HQL.BB.JCL')

makeDirectory(directoryName: string) - Makes USS directory with the given directory name.

• directoryName -string - Makes USS directory with the given directory name.

A promise that resolves on success, rejects on error.

awaitconnection.makeDirectory('/u/user/my_directory'});

listFiles(dirPath: string) - Lists files whose names match with the given path name.

• dirPath -string - Directory to list or file name with widecards (* or ?)

A promise that resolves a list ofUSSEntry.

USSEntry

• name -string - File or directory name
• group -string - Group
• fileType -FileType - File type
• linkedTo -string - The target file if this entry is the link
• lastModified -Date - Last modified date
• owner -string - Owner
• permissions -string - Permission string
• size -number - File size

constlist=awaitconnection.listFiles('/u/user1/');for(constentryoflist){console.log(entry.name,entry.owner,entry.group,entry.size);}

uploadFile(input: Input, destFilePath: string, transferMode: TransferMode = TransferMode.ASCII) - Uploads data to the specified USS file on z/OS.

• input -Input - Input, which can be aReadableStream, aBuffer, or a path to a local file.
• destFilePath -string - Path name of the destination file on z/OS.
• transferMode - TransferMode_ - Data transfer mode, either TransferMode.ASCII or TransferMode.BINARY.

A promise that resolves on success, rejects on error.

import*asfsfrom'fs';constinput=fs.readFileSync('/etc/hosts','utf8');awaitconnection.uploadFile(input,'/u/username/hosts');

downloadFile(filePath: string, transferMode: TransferMode = TransferMode.ASCII, stream = false) - Downloads the specified USS file.

• filePath -string - USS file path name.
• transferMode -TransferMode -TransferMode.ASCII,TransferMode.BINARY. When downloading a text dataset, transferMode should be eitherTransferMode.ASCII so that z/OS FTP service convertsEBCDIC characters toASCII.
• stream -boolean -true if you want to obtain aReadableStream of the file content, orfalse to read a full file into memory (in Buffer). The buffer accepts up to 4MB data. For large file, usestream=true instead.

A promise that resolves content of the file in eitherBuffer orReadableStream.

constjclBuffer=awaitconnection.downloadFile('/etc/hosts',TransferMode.ASCII);console.log('JCL is:');console.log(jclBuffer.toString());constjclStream=awaitconnection.downloadFile('/etc/hosts',TransferMode.ASCII,true);constwritable=fs.createWriteStream('file.txt');jclStream.pipe(writable);

deleteFile(filePath: string, fileType: FileToOperate = FileToOperate.FILE_OR_DIRECTORY) - Deletes the USS files or directory whose names match with the given file path.

• filePath -string - The path name of USS file or directory. ItCAN NOT contain a wildcard (*).

A promise that resolves on success, rejects on error.

awaitconnection.deleteFile('/u/username/myfile');awaitconnection.deleteFile('/u/username/mydir');// Delete it, if it's emptyawaitconnection.deleteFile('/u/username/mydir',FileToOperate.WHOLE_DIRECTORY);// Delete it, even if it's not empty.

renameFile(name: string, newName: string) - Renames USS file/directory.

• name -string - Old file name.
• newName -string - New file name to rename to.

A promise that resolves on success, rejects on error.

awaitconnection.renameFile('/u/username/myfile','/u/username/newfile')

listJobs(queryOption?: JobListOption) - Lists the jobs matching the given query option. If the query option is not provided, it will list all jobs of the current user.

• queryOption -JobListOption - Query option

JobListOption

• jobName -string - Job name, which is optional and can contain a wildcard (*).Default: '*'
• jobId -string - Job ID, which is optional
• owner -string - Job owner, which is optional and can contain a wildcard (*).Default: The current user
• status -string - Job status, eg. ALL, OUTPUT, which is optional.Default: 'ALL'

A promise that resolves an array ofJob. For JESINTERFACELEVEL=2,Job contains validjobName,jobId,owner,status,class.

Job

• jobName -string - Job name
• jobId -string - Job ID
• owner -string - Job owner
• status -string - Job status
• class -string - Job class
• extra -string - Extra information

constjobs:Job[]=awaitconnection.listJobs({jobName:'TSU*',owner:'MY-NAME'})

submitJCL(jclText: string) - Submits job with the specified JCL text.

• jclText -string - JCL text to submit

A promise that resolves the submitted job id.

import*asfsfrom'fs';constjcl=fs.readFileSync('./unpaxz.jcl','utf8');constjobId=awaitconnection.submitJCL(jcl);

queryJob(queryOption: JobIdOption) - Returns the status the job identified by job id and optional job name.

• queryOption -JobIdOption - Job query option

JobIdOption

• jobId -string - Job ID, which is required
• jobName -string - Job name, which is optional and can contain a wildcard (*). Better to have it, if it's known.Default: '*'
• owner -string - Job owner, which is optional.Default: The current user

A promise that resolves status of the job,JobStatusResult.

JobStatusResult

• SUCCESS - Job succeeds
• ACTIVE - Job running
• FAIL - Job fails
• WAITING - Job waiting
• NOT_FOUND - Cannot find job specified by the jobName and jobId

conststatus=awaitconnection.queryJob(jobName,jobId);switch(status){caseJobStatusResult.SUCCESS:console.log('Job succeeded');break;caseJobStatusResult.FAIL:console.log('Job failed');break;caseJobStatusResult.ACTIVE:console.log('Job is running');break;caseJobStatusResult.WAITING:console.log('Job is waiting');break;caseJobStatusResult.NOT_FOUND:console.log('Job is not found');break;}

getJobStatus(queryOption: JobIdOption) - Returns the status of the job specified by query option.

• queryOption -JobIdOption - Job ID option

JobIdOption

• jobId -string - Job ID, which is required
• jobName -string - Job name, which is optional and can contain a wildcard (*). Better to have it, if it's known.Default: '*'
• owner -string - Job owner, which is optional.Default: The current user

A promise that resolves job status,JobStatus.

JobStatus

• jobName -string - Job name
• jobId -string - Job ID
• owner -string - Job owner
• status -string - Job status
• class -string - Job class
• extra -string - Extra information
• rc -string | number - Job RC value, indicating job finished with numberic value or failed with error string
• retcode - string - Job RC value, to support zftp plugin with consistent return code format with z/OSMF.
• spoolFiles -SpoolFile[] - Spool files

SpoolFile

• id -number - Spool file ID
• stepName -string - Job step name
• procStep -string - Proc step name
• class -string - Class
• ddName -string - DD name
• byteCount -number - Bytes

constjobStatus=awaitconnection.getJobStatus(jobId);

getJobLog(queryOption: JobLogOption) - Returns job spool files identified by jobId.

• queryOption -JobLogOption - Job log query option

JobLogOption

• fileId -number - Spool file index (1, 2, 3...), or -1, which returns all spool files separated by!! END OF JES SPOOL FILE !!.Default: -1
• jobId -string - Job ID, which is required
• jobName -string - Job name, which is optional and can contain a wildcard (*).Default: '*'
• owner -string - Job owner, which is optional.Default: The current user

A promise that resolves spool files' contents.

constspoolFileContents=awaitconnection.getJobLog({ jobName, jobId,fileId:-1});spoolFileContents.split(/\s*!!ENDOFJESSPOOLFILE!!\s*/).forEach(function(spoolFile,i){if(spoolFile.length>0){console.log(`Spool file${i}:`);console.log(spoolFile);}});

deleteJob(queryOption: JobIdOption) - Deletes the job of the specified job id.

• queryOption -JobIdOption - Job query option

JobIdOption

• jobId -string - Job ID, which is required
• owner -string - Job owner, which is optional.Default: The current user.

A promise that resolves on success, rejects on error.

awaitconnection.deleteJob({jobId:'JOB25186'});

stat(option) - Retrieve status information from a remote server. The following parameters are accepted:

• option -string - Optional option name like UMASK

A promise that resolves status of the specified option on success, rejects on error. Ifoption is not specified,it returns all status information.

conststatus=awaitconnection.stat('UMASK');console.log(status);

site(siteCommands) - Send site-specific information to a server. The following parameters are accepted:

• siteCommands -string - Site commands separated with space

A promise that resolves text from server on success, rejects on error.

awaitconnection.site('UMASK 007');

This module adopts theModule Long Term Support (LTS) policy, with the following End Of Life (EOL) dates:

Eclipse Public License (EPL)