Related Publications | HP UX Internet and Networking Software

Before You Begin

Related Publications

Contains the information you need to write application programs using High-Level Language Application Program Interface (HLLAPI).

HP-UX SNAplus2 LUA Programmer’s Guide

Contains the information you need to write applications using the Conventional LU Application Programming Interface (LUA).

HP-UX SNAplus2 CSV Programmer’s Guide

Contains the information you need to write application programs using the Common Service Verbs (CSV) API.

HP-UX SNAplus2 MS Programmer’s Guide

Contains the information you need to write applications using the Management Services (MS) API.

HP-UX SNAplus2 NOF Programmer’s Guide

Contains the information you need to write applications using the Node Operator Facility (NOF) API.

Related Publications

For information about SNA, APPN or LU 6.2 architecture, refer to the following IBM documents:

•IBM Systems Network Architecture: LU6.2 Reference: Peer Protocols SC31-6808

•IBM Systems Network Architecture: APPN Architecture Reference SC30-3422.

•IBM Systems Network Architecture: Management Services SC30-3346

•IBM Systems Network Architecture: Formats GA27-3136

•IBM APPN Architecture and Product Implementations Tutorial GG24-3669

•IBM AS/400 Advanced Peer-to-Peer Networking GG24-3287

•IBM Communications Manager/2 System Management Programming Reference SC31-6173

•IBM Communications Manager/2 APPC Programming Guide and Reference SC31-6160

•IBM System/370 Principles of Operation GA22-7000

•IBM Systems Network Architecture: Technical Overview GC30-3073

29

Image 29

HP UX Internet and Networking Software manual Related Publications, HP-UX SNAplus2 LUA Programmer’s Guide

Contents

HP-UX SNAplus2 R7 Administration Command Reference Contents Supplied Parameters Supplied Parameters Returned Parameters Error Return Codes 120 133 199 251 258 273 288 312 330 358 393 434 468 516 550 571 593 Appendix a Common Return Codes from snapadmin Commands Appendix C Government License WarrantyCopyright Notices Trademark Notices New and Changed Information in This Edition Publishing History About This Book Prerequisite KnowledgeOrganization of This Book Typographic Conventions Publications for Users SNAplus2 PublicationsHP-UX SNAplus2 General Information HP-UX SNAplus2 3270 User’s Guide Publications for Programmers Publications for Administrators HP-UX SNAplus2 LUA Programmer’s Guide Related PublicationsHP-UX SNAplus2 CSV Programmer’s Guide HP-UX SNAplus2 MS Programmer’s Guide Introduction to SNAplus2 Administration Commands Command Line Options Using snapadmin Changing Speciﬁc Parameters Using Command Line Help Parameter Syntax Used for Administration Commands Default Parameter Values Subrecords in Administration Commands Listoptions NumentriesFirstinlist Listinclusive Defineethernetdlc, dlcname = DLCNAME, initiallyactive = YES Examples of Administration Commands Supplied Parameters Activatesession Returned Parameters Error Return Codes State Check Addbackup Adddlctrace Backupname Resourcename Resourcetype Sidl SidhOdai Messagetype Aping Security TpnamePwd Userid Consec DlenEcho Iterations Partnerverdata AvgtimeMaxtime Sensedata Setnegotiable Changesessionlimit Minconwinnerssource PlumodesessionlimitMinconwinnerstarget Autoact Modename parameter did not match any deﬁned mode name Deactivateconvgroup Convgroupid DeactcleanupType Deactnormal Deactivatelu0to3 Deactivatesession Plualias Rtmoverﬂow Deﬁne3270diag Rtmunbind RtmtimeroptionRtmthresh1 through rtmthresh4 Description Parameter1 through parameter3 10 deﬁneadjacentlennode Wildcardlus Cpname 11 deﬁnecn Effectcap FqcnnameConnectcost Bytecost Portname PropdelayUserdefparm1 through userdefparm3 Function Not Supported 12 deﬁnecos Transmissionpriority Cosname Mineffectcap MinpropdelayMinconnectcost Minbytecost Minuserdefparm1 through minuserdefparm3 MaxpropdelayMaxeffectcap Maxconnectcost Maxuserdefparm1 through maxuserdefparm3 WeightMinrar Minstatus Weight associated with this node row Symdestname 13 deﬁnecpicsideinfoPartnerluname Tpnametype Conversationsecuritytype SecuritypasswordProgram Programstrong Puname 14 deﬁnedefaultpu Implicitpluforbidden 15 deﬁnedefaults Speciﬁcsecuritycodes Limitedtimeout16 deﬁnedirectoryentry Nncpresource EncpresourceLuresource Wildcardluresource Parenttype 17 deﬁnedlurdefaults Invaliddlusname Comment 18 deﬁnedomainconﬁgﬁle19 deﬁnedownstreamlu Delayedlogon AllowtimeoutDsluname Nauaddress Supplied NAU address was not in the valid range 20 deﬁnedownstreamlurange Maxnau DslubasenameMinnau Returned Parameters 21 deﬁnedsputemplate Modifytemplate TemplatenameMaxinstance Hostlu Name speciﬁed for the templatename parameter was not valid Normal 22 deﬁneemulatoruser Styleﬁle UsernameMaxactsessions Viewrtm Changelu AlertpermissionChangestyle Userisgroup Modeloverride SessionnameSessiontype 5250PRINTER Locallualias5250DISPLAY 24 deﬁneethernetls 23 deﬁneethernetdlc25 deﬁneethernetport 26 deﬁnefddidlc 29 deﬁnefocalpoint 28 deﬁnefddiport Application is the main focal point 30 deﬁneinternalpu Dddluofﬂinesupported PuidInitiallyactive Puname parameter contained a character that was not valid 31 deﬁneipdlc Ipprecedencellc UdpportlowIpprecedencenetwork Ipprecedencehigh Learnnode 32 deﬁneipls Adjcptype LsnameAdjcpname Autoactsupp LsapaddressTgnumber Limitedresource Linkdeacttimer DisableremoteactDefaultnnserver Lsattributes Adjnodeid UsedefaulttgcharsLocalnodeid Cpcpsesssupport Bytecost Reacttimerretry ReacttimerTargetpacingcount Maxsendbtusize Maxifrmrcvd IpacktimeoutBranchlinktype Adjbrnncpsupport Remoteiphost LivenesstimeoutShortholdmode Limitedresource parameter was not set to a valid value 33 deﬁneipport Totlinkactlim MaxrcvbtusizeInblinkactlim Outlinkactlim Nonactxidexchangelimit ActxidexchangelimitRemotehostname Implicitcpcpsesssupport Ipacktimeout through shortholdmode ImplicitdeacttimerImplicituplinktoen Effectcap through userdefparm3 Localipinterface Incoming Calls 34 deﬁnelocallu Listname DefaultpoolSyncptsupport Lusessionlimit Timeout DisableLuattributes Sscpid Disable parameter was not set to a valid value Fqpartnerlu 35 deﬁnelsrouting Wildcardfqplu 36 deﬁnelu0to3 Lumodel PoolnamePriority Termmethod UsenodedefaultSendunbind Sendtermself 37 deﬁnelu0to3range Basename Priority Usebasenumber NameattributesUsehexinname Basenumber Basename parameter contained a character that was not valid Veriﬁcationprotocol 38 deﬁnelulupasswordPassword 39 deﬁnelupool Luname parameters can be speciﬁed Supplied parameters are Globaltimeout 40 deﬁnelu62timeoutLocallutimeout Partnerlutimeout 41 deﬁnemode Receivepacingwin DefaultrusizeMaxrusizeupp Minconwinsrc MaxnegsesslimMinconlosersrc Maxrusizelow Maxreceivepacingwin 42 deﬁnenode Nodetype NodenameFqcpname Cpalias Mdssupported LocatetimeoutNodeid Maxlocates Coscachesize MdssendalertqsizeTreecachesize Treecacheuselimit Storeisrrscvs StoreendptrscvsStoredlurrscvs Costableversion Cplusyncptsupport DisablebranchawarenessCpluattributes Dlursupport Nnrar PuconcsupportMaxlsexceptionevents Maxcompressionlevel Immediaterecontact ImmediatediscontactSuppressreqdiscont Allowbbrqe Nodename parameter contained a character that was not valid 43 deﬁnepartnerlu Maxmcllsendsize PluunnameConvsecurityver Parallelsesssupp Cardtype 44 deﬁneqllcdlc 45 deﬁneqllcls Useportdefaults Administration Commands deﬁneqllcls Address Solicitsscpsessions Dlur DspuservicesPuconcentration Hprsupported Adjnodeid Connectcost Userdefparm1 through userdefparm3 Lspri LsroleLssec Lsneg SVC VctypePVC Locpacket Locwsize ReqrevchargeRemwsize Fac Idletimeout RetrytimeoutPvcid Snid Invaliddspuname Solicitsscpsess parameter was not set to a valid value PU speciﬁed in the puname parameter has already been deﬁned Lsneg 46 deﬁneqllcport Implicitdsputemplate Portnumber Lsxmitrcvcap Implicitdspuservices Lstwa Lstws Cudmode ImplicithprsupportCudmatch Addmode Addlen Vctype through idletimeout Lsrole parameter was not set to a valid value Spcfpermissions 47 deﬁnercfaccessUcfusername Allowactionremote 48 deﬁnerjewkstnAllowdefineremote Primaryuser WorkstationnameGroupname Systemname 49 deﬁnertptuning Pathswitchtimelow PathswitchattemptsPathswitchtimemedium Pathswitchtimehigh Neglssupp 50 deﬁnesdlcdlc Mucredit AdapternumberStatssupport Numports 51 deﬁnesdlcls Administration Commands deﬁnesdlcls Description Address Limitedresource Dspuservices Hprsupported Adjnodeid Bytecost Targetpacingcount Contacttimerretry ContacttimerContacttimer2 Contacttimerretry2 Nvepolltimerretry NvepolltimerNvepolltimer2 Nvepolltimerretry2 Opt1 PolloniframeLinesp Hmoddata Maxifrmrcvd Returned Parameters 196 State Check Escape Sequences for Modem Control Characters Modem Control Characters 52 deﬁnesdlcport Administration Commands deﬁnesdlcport Porttype PortswitchedPortnonswitched Actxidexchangelimit Implicit links to an End Node are uplinks Idletimerretry IdletimerNprcvtimer Nprcvtimerretry Linkconntimerretry LinkconntimerPrifdplx Secfdplx Maxretrycount Maxxidsize Opt2 Pollwait Contacttimer through polloniframeRcvpoolsize Porttype parameter was not set to a valid value 53 deﬁnesecurityaccesslist 54 deﬁnetn3270access Clientaddress Defaultrecord Tn3270support AddressformatAllowspeciﬁclu Printerluname 214 55 deﬁnetn3270association Using the Telnet Daemon’s TCP/IP Port Displayluname 56 deﬁnetn3270defaults Keepalivemethod ForceresponsesNOP Keepaliveinterval 57 deﬁnetp Convtype EnabledSecurityrqd Synclevel Tpinstancelimit Path 58 deﬁnetploadinfo Group ArgumentsStdin Stdout 59 deﬁnetrdlc, deﬁneethernetdlc, deﬁnefddidlc DIX Lantype 60 deﬁnetrls, deﬁneethernetls, deﬁnefddils 226 227 Macaddress 229 230 Hprlinklvlerror 232 233 234 235 Xidtimeout TesttimeoutT1timeout Testretrylimit 237 238 Bit Ordering in MAC Addresses Reversing the Bit Order in a MAC Address 61 deﬁnetrport, deﬁneethernetport, deﬁnefddiport 241 242 243 Implicitlinklvlerror Testtimeout through t1retrylimit 246 Deﬁnetype 62 deﬁneuseridpasswordAdduser Addprofiles Deleteadjacentlennode 249 Deletebackup Deletecn Deletecos Deletecpicsideinfo Deletedirectoryentry 255 Deletedlc Deletedownstreamlu Deletedownstreamlurange 259 Deletedsputemplate 260 Deleteemulatoruser 3270SESSION Deleteoptions5250SESSION Allsessions Deletefocalpoint BackupActive Implicit Deleteinternalpu Deletelocallu Deletels Deletelsrouting 268 Deletelu0to3 Deletelu0to3range 271 Deletelulupassword Deletelupool Deletelu62timeout 275 Deletemode Deletepartnerlu Deleteport Deletercfaccess Deleterjewkstn Deletesecurityaccesslist Deletetn3270access 283 Deletetn3270association Deletetp Deletetploadinfo Deletetype DeleteuseridpasswordRemoveuser Removeprofiles Initnode 289 Initializesessionlimit 290 291 292 Rtpconnectionname Pathswitch Query3270diag Path Switch Failure Rtmoverﬂow through numalerts Alertnumber Query3270user Scope Userpid Returned Parameters Summary InformationReturned Parameters Detailed Information Query3270usersessions 300 301 Queryactivetransaction Reqagentapplname FqreqloccpnameSeqnumdt Fqorigincpname 304 Adjnncpname Queryadjacentnn Outofseqtdus CpcpsessstatusLastfrsnsent Lastfrsnrcvd Queryavailabletp 308 Traceﬂags Querybckcstrace Querybufferavailability Resetmaxvalues Buftotalcount BufavailBuftotalbytes Bufrsrvcount Querycentrallogger Querycentrallogging Querycn Numactports 316 Querycnport Tgnum 319 Queryconversation Convid Administration Commands queryconversation Partnertpname LocaltpnameTpid Sessid Querycos Numoftgrows Numofnoderows Trees QuerycosnoderowCalcs Rejs Noderowindex Minrar through weight Querycostgrow Tgrowindex 328 329 Querycpicsideinfo Partnerluname through lualias Destsys Querycstrace Tracedirection Defpusess QuerydefaultpuDefpuname Querydefaults Speciﬁcsecuritysensecodes Querydirectoryentry 337 338 Realowningcpname Realowningcptype Entrytype Administration Commands querydirectoryentry Suppliercpname LocationSuppliercptype Querydirectorylu 343 Wildcard ServernameLuownername Apparentluownername Querydirectorystats Curcaches MaxcachesCurhomeentries Curregentries Querydlc State Dlctype 350 Querydlctrace Alldlctraces Listtype 353 354 355 Querydlurdefaults Querydlurlu Downstream ﬁlterInternal Rscvlen LulocationPluname Querydlurpu 361 Deﬁneddlusname Activedlusname PulocationAnssupport Pustatus Pcid Querydlus Isdefault Pipestate IsbackupdefaultNumactivepus Reqactpusent Actlurspsent ActlureceivedDactlureceived Dactlurspsent Revisionlevel Majorversion through updatereleaseQuerydomainconﬁgﬁle Querydownstreamlu 371 Plusessactive Lusscpsessactive 373 Sendrusize RcvrusizeMaxsendpacwin Cursendpacwin Rcvfmddataframes RcvdataframesRcvdatabytes Pacingtype 376 Querydownstreampu Pusscpsessactive 379 380 Querydsputemplate Numofdslutemplates Activeinstance Queryemulatoruserdef ALL Emulatortype Numsessions 386 Queryfocalpoint 388 Bkupfpfqcpname BkupapplnameImplicitapplname Implicitfpfqcpname Querygloballogtype Audit SuccincterrorsException Succinctaudits Queryisrsession Isrsessions Dlursessions 394 Sendrpc RscvRcvrpc Sendfmddatabytes Rcvfmddatabytes Limit ResetmaxusedQuerykernelmemorylimit Maxused QuerylocalluActual Listbyalias 400 Applconnactive Syncptsupport through backlevel Activesscpid Querylocaltopology VRN DestDesttype 405 Rsn DlcdataStatus Cpcpsessionactive Branchtg Querylogﬁle BackupﬁlenameLogﬁletype ﬁlename Override Querylogtype 410 Queryls 412 Detadjcptype ActsesscountDetadjcpname 414 415 416 Substate Dynamic Inxidbytes MigrationInmsgbytes Inxidframes Badxids DeterminedhprlinklvlerrorStarttime Stoptime Adjcpisbrnn LstypeDetbranchlinktype Activelusesscount ActiveisrcountActivesscpsesscount Reverseanrlabel 423 424 425 426 427 428 Determinedipaddress Querylsrouting 431 Querylu0to3 Dlurattached HostattachmentDirectattached 434 Returned Parameters for All Application Types 436 437 Bindlutype Additional Returned Parameters for an LU Used by Usertype Apptype Puconcdownstreamlu Returned Parameters for an LU Used by an RJE Workstation Useripaddress CfgdefaultCbnumber Cfgaddress Requestluname Querylulupassword 444 Protocolinuse Protocoldeﬁned Querylupool Numavaillus Numactivelus 448 Querylu62timeout 450 451 Application Querymdsapplication Maxrcvsize Querymdsstatistics Uncorrelatedalerterrors AlerterrorsrcvdAlertssent Mdsmusrcvdlocal Unveriﬁederrors ParseerrorsQuerymode Faileddeliveries 456 Sesslimit Activesessions Drainsource Actcwcount DrainpartnerActclcount Maxnegsesslimit Implicit Querymodedeﬁnition Maxrusizeupp through maxreceivepacingwin Querymodetocosmapping Querynmvtapplication Msvectorkeytype Conversionrequired Querynntopologynode 467 Frsn To Obtain Consistent Information Using the frsn Parameter Functionsupport DaysleftRar Branchaware Querynntopologystats Nodeerrors NodestateupdatesNodetimerupdates Maxnodes Tgerrors TgstateupdatesTgtimerupdates Nodepurges Querynntopologytg Ownertype Owner 476 477 478 Intersubnettg SubareanumberTgtype 480 481 Querynode 482 483 484 Hprsupport BIS ERPSetsearchstatus Limittpsecurity Nnfunctionssupported Forcestandardarb Nnstatus EnfunctionssupportedNnfrsn Nnrsn Dlurreleaselevel DynlsbadxidsFqnnservername Currentisrsessions Querynodeall Conﬁgrole Maxlu62tps Querynodelimits Maxfmapitps MaxluatpsMaxlinkstations Maxtn3270connections Peakdatasessions Peaktn3270connectionsBranchnetworknode Networknode Sslsupport TnserversupportBacklevelclient Querypartnerlu 497 Partnerlulocated Partnercpname Convsecurity Preference SecuritydetailsDuplexsupport Querypartnerludeﬁnition 502 503 Queryport Portstate 506 507 Portsimrim Abmlssupp Numimplicitlinks Version QuerypuLsap 511 512 513 Tcpcvsupported Dddlusupported Queryrcfaccess Queryrjewkstn 517 Wkstnuid WkstnpidWkstngid Wkstngname Queryrjewkstndef Description through luname Queryrtpconnection ﬁrsthoplsname RtpnameDestnodename Numsessactive 523 Arbmode LivenesstimerMaxbtusize Localtcid Bytesdiscarded ShortreqtimerPacketssent Packetsreceived Livenesstimeouts ShortreqtimeoutsDelaychangesum Dcsresetcountnonheal Route Queryrtptuning Querysecurityaccesslist Querysecurityaccesslist 529 Numusers Querysession 531 532 Transpri Contention 535 Sessionstarttime Sessiontimeout Querysnanet Domainname Querystatistics Name ResetstatsStatstype Tabletype Returned Parameters Sdlc LS Statistics Blusin IndexBlusout Octetsin Uiframesin IoctetsoutUiframesout Xidsin Returned Parameters Sdlc LS Operational Information Replyto MaxdataMaxin Maxout Returned Parameters Sdlc Port Statistics Protocolerrs Returned Parameters Sdlc Port Operational InformationActivitytos Rnrlimits Topology SlowpolltimerActivto Pause Lsstmusreceived LsstmussentLsstbytessent Lsstbytesreceived Internalerror LineerrorBursterror Arifcierror Returned Parameters Enterprise Extender Querytn3270accessdef 552 553 554 Querytn3270association 556 Querytn3270defaults Querytnservertrace 559 Querytp 560 Instancelimit QuerytpdeﬁnitionInstancecount Locallystartedcount 562 Listname through tpinstancelimit Querytploadinfo 565 Traceﬁletype Querytraceﬁle ﬁlename2 DualﬁlesTraceﬁlesize Querytracetype Truncationlength Queryuseridpassword Removedlctrace 572 573 Resetsessionlimit ONE Modenameselect Force Draintarget 577 578 Initﬂags Setbckcstrace Setﬂags Setcentrallogging Setbufferavailability Setcstrace Csdata CsadminmsgCsdatagram Csboth CssendCsreceive Leaveunchanged Setgloballogtype 586 Setkernelmemorylimit Action Setlogﬁle Deletefile BackupfileNofileaction Setlogtype 591 592 Fmapi SettnservertraceCFG NOF Settraceﬁle 595 Settracetype LUA AppcDlpi Sdlc Dgrm Startdlc Startinternalpu 601 Startls Enable Remoteact Autoact Unsuccessful Startport 605 Returned Information Statusall 607 Statusconnectivity Lutype Statusdependentlu RJE DisplayLU6 Other Snapadmin statusdependentlu,puname=ETH0 LU62 Statusdlur Example 2-6 Returned Information for the statusdlur Command Statuslu62 Example 2-7 Returned Information for the statuslu62 Command Statusnode Example 2-8 Returned Information for the statusnode Command Parameters Statusremotenode Stoptype StopdlcOrderlystop Immediatestop Stopinternalpu 619 Stopls 621 Stopport Termnode Abort DeactcleanShutdown Quiesce Function Not Supported Communications Subsystem Not Active State Check Parameter Check System Error Conﬁguration File Format Initial Conﬁguration Files Record Format Record Ordering in a Conﬁguration File Subrecord Format Sample snapadmin Input Files File Input to the snapadmin Program Sample Files Delivered with SNAplus2 Config1.cfg Environment Variables That Affect 3270 Emulation Environment Variables That Affect All FunctionsLang Path SNAP3270SI and SNAP3270SO SNAP3270LOWERRIGHT SNAP3270COLOR Environment Variables That Affect RJE Workstations Appcllu Environment Variables That Affect the CSV API Columns Environment Variables That Affect Tracing Snatrunc 639 Index 640 641 642 643 644 645 646 647 648 649 650 651