Examples
Calling the DSPSYSSTS CL Command and Displaying Output
# Bottom
# Type command, press Enter.
# ===> dspsyssts
# Display System Status LP0364D
# 06/22/15 15:22:28
# % CPU used . . . . . . . : .1 Auxiliary storage:
# Elapsed time . . . . . . : 00:00:01 System ASP . . . . . . : 176.2 G
# Jobs in system . . . . . : 428 % system ASP used . . : 75.6481
import config
from itoolkit import *
itool = iToolKit()
itool.add(iCmd5250('dspsyssts', 'dspsyssts'))
# xmlservice
itool.call(config.itransport)
# output
dspsyssts = itool.dict_out('dspsyssts')
if 'error' in dspsyssts:
print (dspsyssts['error'])
exit()
else:
print (dspsyssts['dspsyssts'])
Calling the RTVJOBA CL Command and Getting Output Parameters
# RTVJOBA can't issue from command line,
# but works with itoolkit
import config
from itoolkit import *
# modify iToolKit not include row node
itool = iToolKit(iparm=0, iret=0, ids=1, irow=0)
itool.add(iCmd('rtvjoba', 'RTVJOBA USRLIBL(?) SYSLIBL(?) CCSID(?N) OUTQ(?)'))
# xmlservice
itool.call(config.itransport)
# output
rtvjoba = itool.dict_out('rtvjoba')
print (rtvjoba)
if 'error' in rtvjoba:
print (rtvjoba['error'])
exit()
else:
print('USRLIBL = ' + rtvjoba['USRLIBL'])
print('SYSLIBL = ' + rtvjoba['SYSLIBL'])
print('CCSID = ' + rtvjoba['CCSID'])
print('OUTQ = ' + rtvjoba['OUTQ'])
Calling the PASE ps Command and Getting Output
# > ps -ef
# UID PID PPID C STIME TTY TIME CMD
# qsecofr 12 11 0 May 08 - 8:33 /QOpenSys/QIBM/ProdData/JavaVM/jdk60/32bit/jre/lib/ppc/jvmStartPase 566
# qtmhhttp 31 1 0 May 08 - 0:00 /usr/local/zendsvr/bin/watchdog -c /usr/local/zendsvr/etc/watchdog-monitor.ini -s monitor
import config
from itoolkit import *
itool = iToolKit()
itool.add(iSh('ps', 'ps -ef'))
# xmlservice
itool.call(config.itransport)
# output
ps = itool.dict_out('ps')
if 'error' in ps:
print (ps['error'])
exit()
else:
print (ps['ps'])
Tracing to the Terminal
import config
from itoolkit import *
itool = iToolKit()
itool.add(
iPgm('zzcall','ZZCALLNOT')
.addParm(iData('INCHARA','1a','a'))
)
# xmlservice write trace log to *terminal
itool.trace_open()
itool.call(config.itransport)
itool.trace_close()
zzcall = itool.dict_out('zzcall')
if 'success' in zzcall:
print (zzcall['success'])
else:
print (zzcall['error'])
exit()
Tracing to a File
import config
from itoolkit import *
itool = iToolKit()
itool.add(
iPgm('zzcall','ZZCALLNOT')
.addParm(iData('INCHARA','1a','a'))
)
# xmlservice write trace log to /tmp/python_toolkit_(tonyfile).log
itool.trace_open('tonyfile')
itool.call(config.itransport)
itool.trace_close()
zzcall = itool.dict_out('zzcall')
if 'success' in zzcall:
print (zzcall['success'])
else:
print (zzcall['error'])
exit()
Calling an RPG Program
import config
from itoolkit import *
# XMLSERVICE/ZZCALL:
# D INCHARA S 1a
# D INCHARB S 1a
# D INDEC1 S 7p 4
# D INDEC2 S 12p 2
# D INDS1 DS
# D DSCHARA 1a
# D DSCHARB 1a
# D DSDEC1 7p 4
# D DSDEC2 12p 2
# *+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# * main(): Control flow
# *+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# C *Entry PLIST
# C PARM INCHARA
# C PARM INCHARB
# C PARM INDEC1
# C PARM INDEC2
# C PARM INDS1
itool = iToolKit()
itool.add(iCmd('chglibl', 'CHGLIBL LIBL(XMLSERVICE)'))
itool.add(
iPgm('zzcall','ZZCALL')
.addParm(iData('INCHARA','1a','a'))
.addParm(iData('INCHARB','1a','b'))
.addParm(iData('INDEC1','7p4','32.1234'))
.addParm(iData('INDEC2','12p2','33.33'))
.addParm(
iDS('INDS1')
.addData(iData('DSCHARA','1a','a'))
.addData(iData('DSCHARB','1a','b'))
.addData(iData('DSDEC1','7p4','32.1234'))
.addData(iData('DSDEC2','12p2','33.33'))
)
)
# xmlservice
itool.call(config.itransport)
# output
chglibl = itool.dict_out('chglibl')
if 'success' in chglibl:
print (chglibl['success'])
else:
print (chglibl['error'])
exit()
zzcall = itool.dict_out('zzcall')
if 'success' in zzcall:
print (zzcall['success'])
print (" INCHARA : " + zzcall['INCHARA'])
print (" INCHARB : " + zzcall['INCHARB'])
print (" INDEC1 : " + zzcall['INDEC1'])
print (" INDEC2 : " + zzcall['INDEC2'])
print (" INDS1.DSCHARA: " + zzcall['INDS1']['DSCHARA'])
print (" INDS1.DSCHARB: " + zzcall['INDS1']['DSCHARB'])
print (" INDS1.DSDEC1 : " + zzcall['INDS1']['DSDEC1'])
print (" INDS1.DSDEC2 : " + zzcall['INDS1']['DSDEC2'])
else:
print (zzcall['error'])
exit()
Calling a Service Program with “Hole” Parameter
import config
from itoolkit import *
# Retrieve Hardware Resource List (QGYRHRL, QgyRtvHdwRscList) API
# Service Program: QGYRHR
# Default Public Authority: *USE
# Threadsafe: No
# Required Parameter Group:
# Output Char(*)..............Receiver variable (RHRL0100, RHRL0110)
# Input Binary(4).............Length of receiver variable
# Input Char(8)...............Format name
# Input Binary(4).............Resource category (see hardware resource category)
# I/O Char(*).................Error code
# RHRL0100 Format
# BINARY(4)...................Bytes returned
# BINARY(4)...................Bytes available
# BINARY(4)...................Number of resources returned
# BINARY(4)...................Length of resource entry
# CHAR(*).....................Resource entries
# These fields repeat for each resource.
# BINARY(4)...................Resource category
# BINARY(4)...................Family level
# BINARY(4)...................Line type
# CHAR(10)....................Resource name
# CHAR(4).....................Type number
# CHAR(3).....................Model number
# CHAR(1).....................Status
# CHAR(8).....................System to which adapter is connected
# CHAR(12)....................Adapter address
# CHAR(50)....................Description
# CHAR(24)....................Resource kind (liar, liar, pants on fire ... binary, not char)
# hardware resource category:
# 1 All hardware resources (does not include local area network resources)
# 2 Communication resources
# 3 Local work station resources
# 4 Processor resources
# 5 Storage device resources
# 6 Coupled system adapter resources
# 7 Local area network resources
# 8 Cryptographic resources
# 9 Tape and optical resources
# 10 Tape resources
# 11 Optical resources
itool = iToolKit()
itool.add(
iSrvPgm('qgyrhr','QGYRHR','QgyRtvHdwRscList')
.addParm(
iDS('RHRL0100_t',{'len':'rhrlen'})
.addData(iData('rhrRet','10i0',''))
.addData(iData('rhrAvl','10i0',''))
.addData(iData('rhrNbr','10i0','',{'enddo':'mycnt'}))
.addData(iData('rhrLen','10i0',''))
.addData(iDS('res_t',{'dim':'999','dou':'mycnt'})
.addData(iData('resCat','10i0',''))
.addData(iData('resLvl','10i0',''))
.addData(iData('resLin','10i0',''))
.addData(iData('resNam','10a',''))
.addData(iData('resTyp','4a',''))
.addData(iData('resMod','3a',''))
.addData(iData('resSts','1a',''))
.addData(iData('resSys','8a',''))
.addData(iData('resAdp','12a',''))
.addData(iData('resDsc','50h','')) # was 50a
.addData(iData('resKnd','24h','')) # was 24b
)
)
.addParm(iData('rcvlen','10i0','',{'setlen':'rhrlen'}))
.addParm(iData('fmtnam','10a','RHRL0100'))
.addParm(iData('rescat','10i0','3')) # 3 Local work station resources
.addParm(
iDS('ERRC0100_t',{'len':'errlen'})
.addData(iData('errRet','10i0',''))
.addData(iData('errAvl','10i0',''))
.addData(iData('errExp','7A','',{'setlen':'errlen'}))
.addData(iData('errRsv','1A',''))
)
)
# xmlservice
itool.call(config.itransport)
#output
qgyrhr = itool.dict_out('qgyrhr')
if 'success' in qgyrhr:
print (qgyrhr['success'])
print (" Length of receiver variable......" + qgyrhr['rcvlen'])
print (" Format name......................" + qgyrhr['fmtnam'])
print (" Resource category................" + qgyrhr['rescat'])
RHRL0100_t = qgyrhr['RHRL0100_t']
print (' RHRL0100_t:')
print (" Bytes returned................." + RHRL0100_t['rhrRet'])
print (" Bytes available................" + RHRL0100_t['rhrAvl'])
print (" Number of resources returned..." + RHRL0100_t['rhrNbr'])
print (" Length of resource entry......." + RHRL0100_t['rhrLen'])
if int(RHRL0100_t['rhrNbr']) > 0:
res_t = RHRL0100_t['res_t']
for rec in res_t:
print (" --------------------------------------------------------")
keys = rec.keys()
print (" Resource category............" + rec['resCat'])
print (" Family level................." + rec['resLvl'])
print (" Line type...................." + rec['resLin'])
print (" Resource name................" + rec['resNam'])
print (" Type number.................." + rec['resTyp'])
print (" Model number................." + rec['resMod'])
print (" Status......................." + rec['resSts'])
print (" System adapter connected....." + rec['resSys'])
print (" Adapter address.............." + rec['resAdp'])
print (" Description.................." + rec['resDsc'])
print (" Resource kind................" + rec['resKnd'])
else:
print (qgyrhr['error'])
exit()
Calling a Service Program
import config
from itoolkit import *
# Retrieve Hardware Resource List (QGYRHRL, QgyRtvHdwRscList) API
# Service Program: QGYRHR
# Default Public Authority: *USE
# Threadsafe: No
# Required Parameter Group:
# Output Char(*)..............Receiver variable (RHRL0100, RHRL0110)
# Input Binary(4).............Length of receiver variable
# Input Char(8)...............Format name
# Input Binary(4).............Resource category (see hardware resource category)
# I/O Char(*).................Error code
# RHRL0100 Format
# BINARY(4)...................Bytes returned
# BINARY(4)...................Bytes available
# BINARY(4)...................Number of resources returned
# BINARY(4)...................Length of resource entry
# CHAR(*).....................Resource entries
# These fields repeat for each resource.
# BINARY(4)...................Resource category
# BINARY(4)...................Family level
# BINARY(4)...................Line type
# CHAR(10)....................Resource name
# CHAR(4).....................Type number
# CHAR(3).....................Model number
# CHAR(1).....................Status
# CHAR(8).....................System to which adapter is connected
# CHAR(12)....................Adapter address
# CHAR(50)....................Description
# CHAR(24)....................Resource kind (liar, liar, pants on fire ... binary, not char)
# hardware resource category:
# 1 All hardware resources (does not include local area network resources)
# 2 Communication resources
# 3 Local work station resources
# 4 Processor resources
# 5 Storage device resources
# 6 Coupled system adapter resources
# 7 Local area network resources
# 8 Cryptographic resources
# 9 Tape and optical resources
# 10 Tape resources
# 11 Optical resources
itool = iToolKit()
itool.add(
iSrvPgm('qgyrhr','QGYRHR','QgyRtvHdwRscList')
.addParm(
iDS('RHRL0100_t',{'len':'rhrlen'})
.addData(iData('rhrRet','10i0',''))
.addData(iData('rhrAvl','10i0',''))
.addData(iData('rhrNbr','10i0','',{'enddo':'mycnt'}))
.addData(iData('rhrLen','10i0',''))
.addData(iDS('res_t',{'dim':'999','dou':'mycnt'})
.addData(iData('resCat','10i0',''))
.addData(iData('resLvl','10i0',''))
.addData(iData('resLin','10i0',''))
.addData(iData('resNam','10a',''))
.addData(iData('resTyp','4a',''))
.addData(iData('resMod','3a',''))
.addData(iData('resSts','1a',''))
.addData(iData('resSys','8a',''))
.addData(iData('resAdp','12a',''))
.addData(iData('resDsc','50a',''))
.addData(iData('resKnd','24b',''))
)
)
.addParm(iData('rcvlen','10i0','',{'setlen':'rhrlen'}))
.addParm(iData('fmtnam','10a','RHRL0100'))
.addParm(iData('rescat','10i0','3')) # 3 Local work station resources
.addParm(
iDS('ERRC0100_t',{'len':'errlen'})
.addData(iData('errRet','10i0',''))
.addData(iData('errAvl','10i0',''))
.addData(iData('errExp','7A','',{'setlen':'errlen'}))
.addData(iData('errRsv','1A',''))
)
)
# xmlservice
itool.call(config.itransport)
#output
qgyrhr = itool.dict_out('qgyrhr')
if 'success' in qgyrhr:
print (qgyrhr['success'])
print (" Length of receiver variable......" + qgyrhr['rcvlen'])
print (" Format name......................" + qgyrhr['fmtnam'])
print (" Resource category................" + qgyrhr['rescat'])
RHRL0100_t = qgyrhr['RHRL0100_t']
print (' RHRL0100_t:')
print (" Bytes returned................." + RHRL0100_t['rhrRet'])
print (" Bytes available................" + RHRL0100_t['rhrAvl'])
print (" Number of resources returned..." + RHRL0100_t['rhrNbr'])
print (" Length of resource entry......." + RHRL0100_t['rhrLen'])
if int(RHRL0100_t['rhrNbr']) > 0:
res_t = RHRL0100_t['res_t']
for rec in res_t:
print (" --------------------------------------------------------")
keys = rec.keys()
print (" Resource category............" + rec['resCat'])
print (" Family level................." + rec['resLvl'])
print (" Line type...................." + rec['resLin'])
print (" Resource name................" + rec['resNam'])
print (" Type number.................." + rec['resTyp'])
print (" Model number................." + rec['resMod'])
print (" Status......................." + rec['resSts'])
print (" System adapter connected....." + rec['resSys'])
print (" Adapter address.............." + rec['resAdp'])
print (" Description.................." + rec['resDsc'])
print (" Resource kind................" + rec['resKnd'])
else:
print (qgyrhr['error'])
exit()
Calling a Service Program With an Array Parameter
import config
from itoolkit import *
# D ARRAYMAX c const(999)
# D dcRec_t ds qualified based(Template)
# D dcMyName 10A
# D dcMyJob 4096A
# D dcMyRank 10i 0
# D dcMyPay 12p 2
# *+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# * zzarray: check return array aggregate
# *+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# P zzarray B export
# D zzarray PI likeds(dcRec_t) dim(ARRAYMAX)
# D myName 10A
# D myMax 10i 0
# D myCount 10i 0
itool = iToolKit()
itool.add(iCmd('chglibl', 'CHGLIBL LIBL(XMLSERVICE)'))
itool.add(
iSrvPgm('zzarray','ZZSRV','ZZARRAY')
.addParm(iData('myName','10a','ranger'))
.addParm(iData('myMax','10i0','8'))
.addParm(iData('myCount','10i0','',{'enddo':'mycnt'}))
.addRet(
iDS('dcRec_t',{'dim':'999','dou':'mycnt'})
.addData(iData('dcMyName','10a',''))
.addData(iData('dcMyJob','4096a',''))
.addData(iData('dcMyRank','10i0',''))
.addData(iData('dcMyPay','12p2',''))
)
)
# xmlservice
itool.call(config.itransport)
# output
# print(itool.xml_out())
chglibl = itool.dict_out('chglibl')
if 'success' in chglibl:
print (chglibl['success'])
else:
print (chglibl['error'])
exit()
zzarray = itool.dict_out('zzarray')
# print(zzarray)
if 'success' in zzarray:
print (zzarray['success'])
print (" myName : " + zzarray['myName'])
print (" myMax : " + zzarray['myMax'])
print (" myCount : " + zzarray['myCount'])
dcRec_t = zzarray['dcRec_t']
for rec in dcRec_t:
print (' dcRec_t:')
print (" dcMyName : " + rec['dcMyName'])
print (" dcMyJob : " + rec['dcMyJob'])
print (" dcMyRank : " + rec['dcMyRank'])
print (" dcMyPay : " + rec['dcMyPay'])
else:
print (zzarray['error'])
exit()
Using *debug to Cause XMLSERVICE to Enter a Message Wait
from itoolkit import *
from itoolkit.transport import DirectTransport
print("********************")
print("********************")
print("Hey user,")
print("Using '*debug' transport parameter allows debug halt before run.")
print ("\n itransport = DirectTransport('*here *debug')\n")
print("Expect qsysopr inquire message, you must answer to continue script.")
print("You may attach a debugger before you answer the inquiry.")
print("\n dspmsg qsysopr\n")
print(" Reply inquiry message any character.")
print(" From . . . : ADC 06/25/15 14:08:07")
print(" Debug client 362262/QSECOFR/QP0ZSPWP")
print(" Reply . . : c\n")
print("Script continues to run after answer (call PGM, etc.)")
print("********************")
print("********************")
itransport = DirectTransport("*here *debug") # i will stop, inquiry message qsysopr
itool = iToolKit()
itool.add(iCmd('chglibl', 'CHGLIBL LIBL(XMLSERVICE)'))
itool.add(
iPgm('zzcall','ZZCALL')
.addParm(iData('INCHARA','1a','a'))
.addParm(iData('INCHARB','1a','b'))
.addParm(iData('INDEC1','7p4','32.1234'))
.addParm(iData('INDEC2','12p2','33.33'))
.addParm(
iDS('INDS1')
.addData(iData('DSCHARA','1a','a'))
.addData(iData('DSCHARB','1a','b'))
.addData(iData('DSDEC1','7p4','32.1234'))
.addData(iData('DSDEC2','12p2','33.33'))
)
)
# xmlservice
itool.call(itransport)
# output
chglibl = itool.dict_out('chglibl')
if 'success' in chglibl:
print (chglibl['success'])
else:
print (chglibl['error'])
exit()
zzcall = itool.dict_out('zzcall')
if 'success' in zzcall:
print (zzcall['success'])
print (" INCHARA : " + zzcall['INCHARA'])
print (" INCHARB : " + zzcall['INCHARB'])
print (" INDEC1 : " + zzcall['INDEC1'])
print (" INDEC2 : " + zzcall['INDEC2'])
print (" INDS1.DSCHARA: " + zzcall['INDS1']['DSCHARA'])
print (" INDS1.DSCHARB: " + zzcall['INDS1']['DSCHARB'])
print (" INDS1.DSDEC1 : " + zzcall['INDS1']['DSDEC1'])
print (" INDS1.DSDEC2 : " + zzcall['INDS1']['DSDEC2'])
else:
print (zzcall['error'])
exit()
Using iXml to Get XMLSERVICE Diagnostics
import config
from itoolkit import *
# from itoolkit.transport import DirectTransport
# itransport = DirectTransport("*here *debug") # i will stop, inquiry message qsysopr
itool = iToolKit()
itool.add(iCmd('chglibl2', 'CHGLIBL LIBL(QTEMP XMLSERVICE)'))
itool.add(iCmd('chglibl3', 'CHGLIBL LIBL(SOMEBAD42)'))
myxml = "<diag/>"
itool.add(iXml(myxml))
print(itool.xml_in())
# xmlservice
itool.call(config.itransport)
# itool.call(itransport)
# output
print(itool.xml_out())
diag = itool.dict_out()
if 'version' in diag:
print ("version : "+diag['version'])
print ("job : "+diag['jobnbr']+'/'+diag['jobuser']+'/'+diag['jobname'])
print ("jobipc : "+diag['jobipc'])
print ("curuser : "+diag['curuser'])
print ("ccsid : "+diag['ccsid'])
print ("dftccsid : "+diag['dftccsid'])
print ("paseccsid : "+diag['paseccsid'])
print ("syslibl : "+diag['syslibl'])
print ("usrlibl : "+diag['usrlibl'])
joblog = diag['joblog'].replace("\n"," ")
cpflist = ""
for word in joblog.split(' '):
if word[:3] == 'CPF' or word[:3] == 'MCH':
cpflist += word + " "
if diag['jobcpf'] == "":
diag['jobcpf'] = word
print ("jobcpf : "+diag['jobcpf'] + " ( " + cpflist + ")")
print ("joblog :\n" + diag['joblog'])
Using iXml to Call a Program with a Varchar Parameter
import config
from itoolkit import *
# XMLSERVICE/ZZSRV.ZZVARY:
# P zzvary B export
# D zzvary PI 20A varying
# D myName 10A varying
itool = iToolKit()
itool.add(iXml("<cmd var='chglibl'>CHGLIBL LIBL(XMLSERVICE)</cmd>"))
myxml = "<pgm name='ZZSRV' func='ZZVARY' var='zzvary'>"
myxml += "<parm io='in'>"
myxml += "<data var='myName' type='10A' varying='on'><![CDATA[<Ranger>]]></data>"
myxml += "</parm>"
myxml += "<return>"
myxml += "<data var='myNameis' type='20A' varying='on'><![CDATA[<Mud>]]></data>"
myxml += "</return>"
myxml += "</pgm>"
itool.add(iXml(myxml))
# xmlservice
itool.call(config.itransport)
# output
chglibl = itool.dict_out('chglibl')
if 'success' in chglibl:
print (chglibl['success'])
else:
print (chglibl['error'])
exit()
zzvary = itool.dict_out('zzvary')
if 'success' in zzvary:
print (zzvary['success'])
# print (" myName : " + zzvary['myName']) ... input only, no output
print (" myNameis : " + zzvary['myNameis'])
else:
print (zzvary['error'])
exit()