Interstage Application Server V6.0 Reference Manual

Interstage Application Server
V6.0
Reference Manual (Command Edition)
Reference Manual (Command Edition)
Trademarks
Trademarks of other companies are used in this user guide only to identify particular products or
systems:
Product
Trademark/Registered Trademark
Microsoft, Visual Basic, Visual C++, Windows, Registered trademarks of Microsoft Corporation in the
Windows NT, Internet Information Server, and U.S.A. and other countries
Internet Explorer
Sun, Solaris, Java, and other trademarks
containing Java
Trademarks of Sun Microsystems, Inc., in the U.S.A.
and other countries
UNIX
Registered trademark in the U.S.A. and other
countries, licensed exclusively through X/Open
Company Ltd
Netscape, Netscape FastTrack Server,
Netscape Enterprise Server, and Netscape
Navigator
Registered trademarks of Netscape Communications
Corporation in the U.S.A. and other countries
CORBA, Object Management Group, OMG,
OMG IDL, IIOP, Object Request Broker, and
ORB
Trademarks or registered trademarks of Object
Management Group, Inc., in the U.S.A. and other
countries
Interstage and ObjectDirector
Registered trademarks of Fujitsu Limited
This document contains technology relating to strategic products controlled by export
control laws of the producing and/ or exporting countries. This document or a portion
thereof should not be exported (or re-exported) without authorization from the
appropriate government authorities in accordance with such laws.
Fujitsu Limited
First Edition (November 2003)
The contents of this manual may be revised without prior notice.
All Rights Reserved, Copyright © FUJITSU LIMITED 2003
ii
Preface
Purpose of this Document
This manual explains the commands provided by Interstage Application Server.
Note
Throughout this manual Interstage Application Server is referred to as Interstage.
Who Should Read this Document?
This manual is intended for users of Interstage Application Server and developers of distributed
applications with Interstage Application Server.
It is assumed that readers of this manual have a basic knowledge of:
•
The Internet
•
Object-oriented technology
•
Distributed object technology (CORBA)
•
Relational databases
•
AIM on a global server
•
XML
•
SOAP and Web service
•
SOAP security extension and digital signatures (XML digital signatures and XML partial encryption)
•
Windows NT® and Windows® 2000
•
Solaris OE
•
Linux
iii
Reference Manual (Command Edition) - Preface
Organization of this Document
This document is organized as follows:
Part 1 Interstage Operation Edition
•
Chapter 1 Interstage Setup Commands
This chapter describes the commands for running Interstage in its entirety.
•
Chapter 2 Interstage Operation Tool Commands
This chapter describes the commands for using the Interstage Operation Tool.
Part 2 J2EE Edition
•
Chapter 3 J2EE Operation Commands
This chapter describes the operation commands provided by J2EE.
•
Chapter 4 Servlet Service Operation Commands
This chapter describes the Servlet Service operation commands.
•
Chapter 5 EJB Service Operation Commands
This chapter describes the EJB Service operation commands.
•
Chapter 6 JNDI Operation Commands
This chapter describes the JNDI operation commands.
•
Chapter 7 JMS Operation Commands
This chapter describes the JMS operation commands.
Part 3 SOAP Edition
•
Chapter 8 SOAP Service Operation Commands
This chapter describes the SOAP Service operation commands.
Part 4 Web Server Operation Edition
•
Chapter 9 Interstage HTTP Server Operation Commands
This chapter describes the Interstage HTTP Server operation commands.
•
Chapter 10 InfoProvider Pro Operation Commands
This chapter describes the InfoProvider Pro operation commands.
•
Chapter 11 SSL Operation Commands
This chapter describes the SSL operation commands.
Part 5 OLTP System Operation Edition
iv
•
Chapter 12 Component Transaction Service Operation Commands
This chapter describes the Component Transaction Service operation commands.
•
Chapter 13 Database Linkage Service Operation Commands
This chapter describes the Database Linkage Service operation commands.
•
Chapter 14 CORBA Service Operation Commands
This chapter describes the CORBA Service operation commands.
•
Chapter 15 WorkUnit Management Commands
This chapter describes the WorkUnit management commands.
•
Chapter 16 Event Service Operation Commands
Reference Manual (Command Edition) - Preface
This chapter describes the Event Service operation commands.
•
Chapter 17 Portable-ORB Environment Setup Commands
This chapter describes the Portable-ORB environment setup commands.
•
Chapter 18 Performance Analysis Monitoring Commands
This chapter describes the performance analysis monitoring commands.
•
Chapter 19 Directory Service Linkage Setup Commands
This chapter describes the Directory Service linkage setup commands.
Part 6 Cluster Service Operation Edition
•
Chapter 20 Cluster Service Operation Commands
This chapter describes the Cluster Service operation commands.
Part 7 Development Edition
•
Chapter 21 Application Development Commands
This chapter describes the application development commands.
Part 8 Maintenance Edition
•
Chapter 22 Backup Commands
This chapter describes the backup commands.
•
Chapter 23 Maintenance Commands
This chapter describes the maintenance commands.
Part 9 Appendixes
•
Appendix A Load Balancing Operation Commands
This chapter describes the Load Balancing operation commands.
•
Appendix B Server Machine Monitor Agent Commands
This chapter describes the Server Machine Monitor Agent commands.
v
Reference Manual (Command Edition) - Preface
vi
Table of Contents
Part 1 Interstage Operation Edition
Chapter 1 Interstage Setup Commands
iscreatesys ......................................................................................................................................1-2
isdeletesys ......................................................................................................................................1-3
isgendef...........................................................................................................................................1-4
isinit .................................................................................................................................................1-8
islistsys..........................................................................................................................................1-14
ismodifyservice .............................................................................................................................1-15
isresetservice ................................................................................................................................1-21
isregistdef......................................................................................................................................1-22
isstart.............................................................................................................................................1-25
isstat..............................................................................................................................................1-28
isstop.............................................................................................................................................1-32
Chapter 2 Interstage Operation Tool Commands
isstartoptool.....................................................................................................................................2-2
isstopoptool .....................................................................................................................................2-3
isstatoptool ......................................................................................................................................2-4
issetupoptool...................................................................................................................................2-5
interstage ........................................................................................................................................2-7
S99FJSVwgui .................................................................................................................................2-9
Part 2 J2EE Edition
Chapter 3 J2EE Operation Commands
ijsdeployment ..................................................................................................................................3-2
ijsundeployment ..............................................................................................................................3-5
ijslistapl............................................................................................................................................3-7
vii
Reference Manual (Command Edition): Table of Contents
Chapter 4 Servlet Service Operation Commands
jssrs_start........................................................................................................................................4-2
jssrs_stop ........................................................................................................................................4-4
jssrs_ clean .....................................................................................................................................4-5
Chapter 5 EJB Service Operation Commands
ejbmakeapfolder..............................................................................................................................5-2
ejbmakecontainer............................................................................................................................5-4
ejbdelcontainer................................................................................................................................5-5
ejbinstalleb ......................................................................................................................................5-7
ejbuninstalleb ................................................................................................................................5-10
ejbdstarteb ....................................................................................................................................5-12
ejbdstopeb.....................................................................................................................................5-15
ejbinfoapfolder...............................................................................................................................5-17
ejbinfocontainer.............................................................................................................................5-22
ejbcustx .........................................................................................................................................5-25
ejbdefexport ..................................................................................................................................5-27
ejbdefimport ..................................................................................................................................5-30
ejbdbdefexport ..............................................................................................................................5-32
ejbdbdefimport ..............................................................................................................................5-34
Chapter 6 JNDI Operation Commands
fjj2eeadmin......................................................................................................................................6-2
j2eejndisetup .................................................................................................................................6-12
Chapter 7 JMS Operation Commands
Commands Overview......................................................................................................................7-2
jmsmkfact ........................................................................................................................................7-3
jmsrmfact.........................................................................................................................................7-6
jmsinfofact .......................................................................................................................................7-7
jmsmkdst .........................................................................................................................................7-9
jmsrmdst........................................................................................................................................7-12
jmsinfodst ......................................................................................................................................7-13
jmsrmds.........................................................................................................................................7-15
jmsinfods .......................................................................................................................................7-16
viii
Reference Manual (Command Edition) - Table of Contents
jmssetupcluster .............................................................................................................................7-17
jmschmod......................................................................................................................................7-19
Part 3 SOAP Edition
Chapter 8 SOAP Service Operation Commands
soapmodifydd..................................................................................................................................8-2
soapdd2wsdd..................................................................................................................................8-9
soapgwstartclgw ...........................................................................................................................8-12
soapgwstopclgw............................................................................................................................8-14
soapgwaddclgw ............................................................................................................................8-16
soapgwdelclgw..............................................................................................................................8-19
soapgwlistclgw ..............................................................................................................................8-21
soapidl2wsdl .................................................................................................................................8-24
soapwsdl2idl .................................................................................................................................8-39
soapsecsignconf ...........................................................................................................................8-43
soapsecverifyconf .........................................................................................................................8-47
soapsecencconf ............................................................................................................................8-51
soapsecdecconf ............................................................................................................................8-55
soapsecrelconf..............................................................................................................................8-59
soapcldeploy .................................................................................................................................8-69
Part 4 Web Server Operation Edition
Chapter 9 Interstage HTTP Server Operation Commands
apachectl.........................................................................................................................................9-2
htpasswd .........................................................................................................................................9-4
ihsrlog..............................................................................................................................................9-6
Chapter 10 InfoProvider Pro Operation Commands
ippadpasswd .................................................................................................................................10-3
ippdisp...........................................................................................................................................10-5
ipprestart .....................................................................................................................................10-10
ippsetstartup................................................................................................................................10-13
ippstart ........................................................................................................................................10-15
ippstartsv.....................................................................................................................................10-17
ippstop.........................................................................................................................................10-18
ix
Reference Manual (Command Edition): Table of Contents
ippstopsv .................................................................................................................................... 10-20
Chapter 11 SSL Operation Commands
SSL Environment Setting Commands ..........................................................................................11-2
cmdspcert ................................................................................................................................11-2
cmentcert .................................................................................................................................11-3
cmentcrl....................................................................................................................................11-4
cmenterkey ..............................................................................................................................11-5
cmentpfx...................................................................................................................................11-6
cmgetcrl....................................................................................................................................11-8
cmlistcert ..................................................................................................................................11-9
cmlistcrl .................................................................................................................................. 11-11
cmmakecsr.............................................................................................................................11-12
cmmkenv................................................................................................................................11-14
cmmkpfx.................................................................................................................................11-15
cmrmcert ................................................................................................................................11-17
cmsetenv................................................................................................................................11-17
ejbsetssleb .............................................................................................................................11-19
ejbunsetssleb .........................................................................................................................11-20
esmkchnl ................................................................................................................................11-21
essetup...................................................................................................................................11-21
ihsregistupin...........................................................................................................................11-22
ippregistupin...........................................................................................................................11-23
makeslot.................................................................................................................................11-25
maketoken .............................................................................................................................11-26
mkslt.......................................................................................................................................11-27
mktkn......................................................................................................................................11-28
odsetSSL................................................................................................................................11-30
odsetpath ...............................................................................................................................11-32
scsmakeenv ...........................................................................................................................11-33
scsenter..................................................................................................................................11-39
scsdelete ................................................................................................................................11-41
scslistcrl..................................................................................................................................11-42
soapSetSecurity.....................................................................................................................11-43
soapMngSecurity ...................................................................................................................11-50
x
Reference Manual (Command Edition) - Table of Contents
Part 5 OLTP System Operation Edition
Chapter 12 Component Transaction Service Operation Commands
tdadddef ........................................................................................................................................12-2
tddeldef .........................................................................................................................................12-4
tdinfobj...........................................................................................................................................12-5
tdinhibitobj .....................................................................................................................................12-7
tdlinkapm.......................................................................................................................................12-8
tdlinknormapm ............................................................................................................................12-11
tdlistobj ........................................................................................................................................12-13
tdpermitobj ..................................................................................................................................12-14
tdsecmode...................................................................................................................................12-15
tdsetup ........................................................................................................................................12-16
tdstart ..........................................................................................................................................12-17
tdstop ..........................................................................................................................................12-18
tdtransfer .....................................................................................................................................12-20
tdunsetup ....................................................................................................................................12-23
Chapter 13 Database Linkage Service Operation Commands
otsalive ..........................................................................................................................................13-2
otsmklog........................................................................................................................................13-4
otsmonitor .....................................................................................................................................13-7
otspendlist ...................................................................................................................................13-10
otssetrsc......................................................................................................................................13-14
otssetup.......................................................................................................................................13-19
otsstart ........................................................................................................................................13-21
otsstartrsc....................................................................................................................................13-22
otsstop.........................................................................................................................................13-24
otsstoprsc....................................................................................................................................13-26
otstranlist.....................................................................................................................................13-28
xi
Reference Manual (Command Edition): Table of Contents
Chapter 14 CORBA Service Operation Commands
CosNaming_s................................................................................................................................14-2
InterfaceRep_Cache_s .................................................................................................................14-4
InterfaceRep_Cache_e .................................................................................................................14-7
K00stopod .................................................................................................................................. 14-10
OD_impl_inst...............................................................................................................................14-11
OD_kill........................................................................................................................................ 14-22
OD_or_adm................................................................................................................................ 14-23
OD_set_env ............................................................................................................................... 14-33
OD_stop ..................................................................................................................................... 14-35
S99startod .................................................................................................................................. 14-36
odadmin ..................................................................................................................................... 14-40
odadmin_ex................................................................................................................................ 14-43
odcntlque.................................................................................................................................... 14-46
odlistir ......................................................................................................................................... 14-49
odlistns ....................................................................................................................................... 14-53
odsethost.................................................................................................................................... 14-56
odsetque .................................................................................................................................... 14-58
Chapter 15 WorkUnit Management Commands
isaddwudef ....................................................................................................................................15-2
isdelwudef .....................................................................................................................................15-3
islistwu...........................................................................................................................................15-4
isstartwu ........................................................................................................................................15-6
isstopwu ........................................................................................................................................15-8
islistwudef................................................................................................................................... 15-10
isinfwudef ....................................................................................................................................15-11
isresetretrycount......................................................................................................................... 15-12
isinfobj ........................................................................................................................................ 15-13
islistobj ....................................................................................................................................... 15-18
islistaplproc ................................................................................................................................ 15-20
isinhibitque ................................................................................................................................. 15-22
ispermitque................................................................................................................................. 15-24
tdformsnap ................................................................................................................................. 15-26
xii
Reference Manual (Command Edition) - Table of Contents
tdfreesnap ...................................................................................................................................15-27
tdlistwu ........................................................................................................................................15-28
tdlistwusnap ................................................................................................................................15-29
tdmodifywu ..................................................................................................................................15-30
tdmodifyprocnum ........................................................................................................................15-32
tdstartsnap ..................................................................................................................................15-34
tdstartwu......................................................................................................................................15-35
tdstopsnap...................................................................................................................................15-37
tdstopwu......................................................................................................................................15-38
Chapter 16 Event Service Operation Commands
Command Summary .....................................................................................................................16-2
esmkchnl .......................................................................................................................................16-3
esmkunit........................................................................................................................................16-8
esmonitor ....................................................................................................................................16-14
esmonitorchnl..............................................................................................................................16-16
essecmode..................................................................................................................................16-19
essetcnf.......................................................................................................................................16-21
essetcnfchnl ................................................................................................................................16-26
essetup........................................................................................................................................16-30
esstart .........................................................................................................................................16-32
esstartchnl...................................................................................................................................16-33
esstartfctry...................................................................................................................................16-34
esstartunit....................................................................................................................................16-35
esstop..........................................................................................................................................16-36
esstopchnl ...................................................................................................................................16-38
esstopfctry...................................................................................................................................16-40
esstopunit....................................................................................................................................16-42
esrmchnl......................................................................................................................................16-44
esrmunit ......................................................................................................................................16-45
esunsetup ...................................................................................................................................16-46
Chapter 17 Portable-ORB Environment Setup Commands
porbeditenv ...................................................................................................................................17-2
xiii
Reference Manual (Command Edition): Table of Contents
Chapter 18 Performance Analysis Monitoring Commands
ispmakeenv ...................................................................................................................................18-2
ispdeleteenv ..................................................................................................................................18-5
ispstart...........................................................................................................................................18-6
ispstop ...........................................................................................................................................18-8
ispstatus ........................................................................................................................................18-9
ispreport ..................................................................................................................................... 18-12
ispsetagt ..................................................................................................................................... 18-19
ispunsetagt................................................................................................................................. 18-20
ispsetautostart ............................................................................................................................ 18-21
ispunsetautostart........................................................................................................................ 18-22
ispinfautodef............................................................................................................................... 18-23
Chapter 19 Directory Service Linkage Setup Commands
tdresetaso......................................................................................................................................19-2
tdsetauthmanager .........................................................................................................................19-3
Part 6 Cluster Service Operation Edition
Chapter 20 Cluster Service Operation Commands
isgetstatus .....................................................................................................................................20-2
isstandby .......................................................................................................................................20-3
isstandbywu ..................................................................................................................................20-4
isrelease........................................................................................................................................20-5
isreleasewu ...................................................................................................................................20-6
odinspect.......................................................................................................................................20-7
tdrelease .......................................................................................................................................20-9
tdreleasewu................................................................................................................................ 20-10
tdstandby.....................................................................................................................................20-11
tdstandbywu ............................................................................................................................... 20-12
xiv
Reference Manual (Command Edition) - Table of Contents
Part 7 Development Edition
Chapter 21 Application Development Commands
IDLc...............................................................................................................................................21-2
otslinkrsc .....................................................................................................................................21-21
otsmkxapgm................................................................................................................................21-25
tdc ...............................................................................................................................................21-32
Part 8 Maintenance Edition
Chapter 22 Backup Commands
esbackupsys .................................................................................................................................22-3
esrestoresys..................................................................................................................................22-5
ijsbackup .......................................................................................................................................22-7
ijsrestore........................................................................................................................................22-9
ippbackup....................................................................................................................................22-11
ipprestore ....................................................................................................................................22-13
irdelete ........................................................................................................................................22-15
iscbackupsys...............................................................................................................................22-17
iscrestoresys ...............................................................................................................................22-19
isguibackup .................................................................................................................................22-21
isguirestore .................................................................................................................................22-24
issoapbackup ..............................................................................................................................22-27
issoaprestore ..............................................................................................................................22-29
j2eebackup..................................................................................................................................22-31
j2eerestore ..................................................................................................................................22-32
jmsbackup ...................................................................................................................................22-33
jmsrestore ...................................................................................................................................22-35
obfbkup .......................................................................................................................................22-37
obfrestore ....................................................................................................................................22-39
odbackupsys ...............................................................................................................................22-41
odexportir ....................................................................................................................................22-42
odexportns ..................................................................................................................................22-45
odimportir ....................................................................................................................................22-48
odimportns ..................................................................................................................................22-51
xv
Reference Manual (Command Edition): Table of Contents
odrestoresys............................................................................................................................... 22-55
otsbackupsys ............................................................................................................................. 22-58
otsrestoresys.............................................................................................................................. 22-59
tdbackupsys ............................................................................................................................... 22-60
tdrestoresys................................................................................................................................ 22-62
Chapter 23 Maintenance Commands
iscollectinfo....................................................................................................................................23-2
esdump .........................................................................................................................................23-4
eslogdump.....................................................................................................................................23-5
irlogdump ......................................................................................................................................23-7
odcvttrace......................................................................................................................................23-9
odformsnap ................................................................................................................................ 23-10
odformtrace ................................................................................................................................ 23-12
odfreesnap ................................................................................................................................. 23-14
odprtcurparam............................................................................................................................ 23-15
odprthdrtrace.............................................................................................................................. 23-17
odstartsnap ................................................................................................................................ 23-18
odstopsnap................................................................................................................................. 23-20
otsgetdump................................................................................................................................. 23-22
tdalllog ........................................................................................................................................ 23-28
Part 9 Appendixes
Appendix A Load Balancing Operation Commands
odadministerlb................................................................................................................................ A-2
oddisplaylbobj ................................................................................................................................ A-4
odnotifydown .................................................................................................................................. A-6
odnotifyrecover............................................................................................................................... A-7
odsetlbo.......................................................................................................................................... A-8
odstartlbo ..................................................................................................................................... A-10
odstoplbo...................................................................................................................................... A-11
xvi
Reference Manual (Command Edition) - Table of Contents
Appendix B Server Machine Monitor Agent Commands
isaddtarget ..................................................................................................................................... B-2
isdeletetarget.................................................................................................................................. B-3
isdisplaysmm ................................................................................................................................. B-4
issetsmm ........................................................................................................................................ B-6
issetsmma ...................................................................................................................................... B-8
isstopsmm .................................................................................................................................... B-10
isstartsmm.....................................................................................................................................B-11
isstartsmma.................................................................................................................................. B-13
isstopsmma .................................................................................................................................. B-15
isunsetsmm .................................................................................................................................. B-16
isunsetsmma ................................................................................................................................ B-17
Index
xvii
Reference Manual (Command Edition): Table of Contents
xviii
Part 1
Interstage Operation Edition
Chapter 1
Interstage Setup Commands
This chapter details the Interstage setup commands.
The Interstage integrated command is used for the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus.
Note
Only the following commands are available for Standard Edition and Plus:
−
isgendef
−
isinit
−
ismodifyservice
−
isresetservice
−
isregistdef
−
isstart
−
isstat
−
isstop
1-1
Chapter 1: Interstage Setup Commands
iscreatesys
Name
iscreatesys
Creates a system
Synopsis
iscreatesys {[-d directory path] | [-a]} system-name
Description
This command creates a system.
The option and argument for this command is as follows:
In addition, -d option and -a option cannot be specified simultaneously.
-d directory path
Specify the directory in which system resources are to be stored. It specifies in the character sequence
except the blank character which starts in "/." The maximum length who can specify is 512 bytes. If this
argument is omitted, a system directory is generated like a default system (under FJSVisas package
installation directory/var/system).
-a
Adds components installed after system creation to the system. Specify a system name that is already
created.
system-name
Specify the name of the system to be created. The system name must be unique in the server and
consist of alphanumeric characters beginning with a upper-case letter (within 8 bytes). The system
name is case-sensitive.
Note
Only system administrators are authorized to execute this command.
Example
iscreatesys
iscreatesys
iscreatesys
1-2
system1
-d /proj system1
-a system1
isdeletesys
isdeletesys
Name
isdeletesys
Deletes a system
Synopsis
isdeletesys system-name
Description
This command deletes a system.
The argument for this command is as follows:
system-name
Specify the name of the system to be deleted. Specify a unique system name on the server using
alphanumeric characters of up to eight bytes. Uppercase and lowercase characters are distinguished.
Notes
•
Only system administrators are authorized to execute this command.
•
Stop all the services constituting the system to be deleted before executing this command.
The default system cannot be deleted.
Example
isdeletesys
system1
1-3
Chapter 1: Interstage Setup Commands
isgendef
Name
isgendef
Generates Interstage System Definition
Synopsis
isgendef [-M system-name] scale-value
Description
This command generates the Interstage System Definition, based on the system scale specified at
scale-value.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
scale-value
Specify one of the following system scales in scale-value. Scale-value is mandatory.
small
Small scale system having less than 5 clients
moderate
Moderate scale system having 6-10 clients
large
Large scale system having 11-50 clients
super
Super scale system having 51-100 clients
The Interstage System Definition is stored in the following file:
Interstage install folder\td\etc\isdef\isconf.txt
1-4
isgendef
small:
Small scale system having 50 clients or less
moderate:
Moderate scale system having 51-100 clients
large:
Large scale system having 101-500 clients
super:
Super scale system having 501-1000 clients
The Interstage System Definition is stored in the following file:
/opt/FSUNtd/etc/isdef/isconf.txt
small:
Small scale system having 50 clients or less
moderate:
Moderate scale system having 51-100 clients
large:
Large scale system having 101-500 clients
super:
Super scale system having 501-1000 clients
The Interstage System Definition is stored in the following file:
/opt/FJSVtd/etc/isdef/isconf.txt
Notes
•
Only system administrators are authorized to execute this command.
•
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
1-5
Chapter 1: Interstage Setup Commands
webgw_stop
odsetlbo
odstartlbo
odstoplbo
jssvstart (*)
jssvstop (*)
soapgwstartclgw (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Chache_s
InterfaceRep_Chache_e
OD_stop
apachectl
•
1-6
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterFaceRep_Cache Service)
−
Interface Repository (InterfaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (INTERSTAGE JServlet) (*)
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
−
Interstage HTTP Server (*)
isgendef
•
"super" cannot be specified for the system scale.
Example
The following example generates the Interstage System Definition on a large scale system:
isgendef large
1-7
Chapter 1: Interstage Setup Commands
isinit
Name
isinit
Initializes Interstage
Synopsis
isinit [-M system-name] [-f] [-w] TYPE1 | TYPE2 | TYPE3 | type1 | type2 |
type3 [EJB | ejb]
isinit [-M system-name] -l
Description
This command initializes the services that are related to the operation type specified in the operand.
The services which can be initialized by the isinit command are shown below:
1-8
−
CORBA Service
−
Naming Service
−
Interface Repository (standard Interface)
−
Interface Repository (value Interface)
−
Event Service
−
Component Transaction Service
−
Database Linkage Service
−
Load Balancing Option
−
WWW Server
−
HTML Page Editing Service
−
Servlet Service
−
CORBA/SOAP Client Gateway
−
Interstage HTTP Server (Enterprise Edition and Standard Edition only)
−
CORBA Service
−
Naming Service
−
Interface Repository (standard Interface)
isinit
−
Interface Repository (value Interface)
−
Event Service
−
Component Transaction Service
−
Database Linkage Service
−
Load Balancing Option
−
Servlet Service
−
CORBA/SOAP Client Gateway
−
Interstage HTTP Server (Enterprise Edition and Standard Edition only)
It is necessary to initialize the services before starting Interstage with the isstart command. isinit
initializes the services, and isstart sets Interstage in the executable state.
It is only necessary to use this command the first time Interstage starts. Thereafter, use this command to
change the initialization status of Interstage.
The parameters required by each service when Interstage is initialized are read from the Interstage
operating environment definition file. These parameters (required by the service) must be already
initialized in the environment definition file.
The following items can be set by customizing the Interstage operating environment definition:
•
Database type used by the Interface Repository, and path and size setting.
•
Database type used by the Interface Repository, and path , size , user name and group name
setting.
•
Naming Service host and port number.
•
Folder path to create the TransactionDirector operating environment file.
•
Multiple degrees of Database Linkage Service, system log file path, and maximum number of
transactions.
For information about the Interstage operating environment definition syntax, refer to the Operator's
Guide.
1-9
Chapter 1: Interstage Setup Commands
The arguments for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-l
Displays the current operation status. This option is valid only if the Interstage initialization process
(invoked by the isinit command) is completed. Interstage cannot be initialized once this option has been
specified.
-f
Forced initialization mode.
The registered information of both the application status and of all services that are specified by the
Interstage operating environment definition must be initialized. Thereby, the data (already registered
WorkUnit definition information and object reference) that has been registered before initialization is all
deleted.
-w
This option is valid only when the cluster service function of Interstage is used.
Specify this option to initialize a standby node.
If type2 is specified as the operation type, the system log file of the Database Linkage Service must
exist under the directory specified by "OTS path for system log" in the Interstage operating environment
definition.
TYPE1 or type1
This is the application status that consists of the CORBA Service, Naming Service, Interface Repository
and Component Transaction Service.
TYPE2 or type2
This is the application status that consists of the CORBA Service, Naming Service, Interface Repository,
Component Transaction Service and Database Linkage Service.
TYPE3 or type3
This is the application status that consists of the CORBA Service and Component Transaction Service.
EJB or ejb
This is specified when using the EJB Service.
When the application status is TYPE3 (type3), it can be specified only when the Interface Repository of
local host is used. Perform registration for a operating environment definition that enables use of the
Interface Repository in the local host.
1-10
isinit
Notes
•
Only system administrators are authorized to execute this command.
•
Multi-execution of this command is not possible.
•
This command cannot be executed in the following circumstances:
−
When any Interstage services are operating.
−
When any of the isgendef, isregistdef, isstart, isstop or isstat commands are being executed
•
To execute this command, use comment markers for the host name of the Interface Repository
service and Naming Service specified in the inithost file, or remove them. If you set another host in
the inithost file, execute this command, then set the host.
•
When the isinit command is executed for events except for initial introduction, there may be a case
where the registered resources that meet the following conditions are deleted. It is recommended
to make a backup copy of all of the Interstage resources beforehand. For backup details, refer to
the Operator's Guide. Resources other than the following are taken over except when the -f option
is specified.
−
The services that are excluded from the target of setup.
−
The services whose definition items in the Interstage operating environment definition are
changed. (However, if any of the Naming Service, Interface Repository, Event Service and
Load Balance option is changed concerning their definition items, the already registered
information of these four services is deleted.)
•
When the Naming Service is initialized using this command, the Naming Service becomes the
setup that is used for the expansion function of the Naming Service. However, when applications
created by an Interstage version before V2.1 are going to be run, the setup that does not use the
extension function of the Naming Service must be implemented. To do so, customize the nsconfig
file and implement the setup not to use the extension function of the Naming Service. For details of
the nsconfig file, refer to the Tuning Guide.
•
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
webgw_stop
1-11
Chapter 1: Interstage Setup Commands
odsetlbo
odstartlbo
odstoplbo
jssvstart (*)
jssvstop (*)
soapgwstartclgw (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Chache_s
InterfaceRep_Chache_e
OD_stop
apachectl
1-12
•
When the Event Service is used, use the esmkchnl command to create the event channel and then,
before initializing Interstage, use the esrmchnl command to delete the created event channel. For
details of the esrmchnl command, refer to esrmchnl in Chapter 16.
•
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterFaceRep_Cache Service)
−
Interface Repository (InterFaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (INTERSTAGE JServlet) (*)
isinit
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
−
Interstage HTTP Server (*)
1-13
Chapter 1: Interstage Setup Commands
islistsys
Name
islistsys
Displays a list of systems.
Synopsis
islistsys [-v]
Description
This command displays a list of systems that exist on the server.
The options for this command are as follows:
-v
Displays the detail information of each system on the server in addition to the system name. When this
option is specified, the following information is displayed:
SYSTEM
: system name
DESCRIPTION : System profile
DIRECTORY : System directory (directory where the system resources are stored)
Example
When the option is omitted
islistsys
SYSTEM
default
system1
When the -v option is specified
1-14
islistsys -v
SYSTEM
DESCRIPTION
DIRECTORY
:
:
:
default
/var/opt/FJSVis/system/default
SYSTEM
DESCRIPTION
DIRECTORY
:
:
:
system1
extension system1
/proj/system1
ismodifyservice
ismodifyservice
Name
ismodifyservice
An addition/change/deletion of service by Interstage employment environment.
Synopsis
The addition of service
ismodifyservice [-M system name] -a | -d ES|Servlet|SOAPCLGW|FJapache
Additional Naming Service of service and the reference place of Interface
Repository (a standard interface / value interface) are changed into a local
host.
ismodifyservice [-M system name] -a NS|IR
It is remote about Naming Service and the reference place of Interface
Repository (standard interface). It changes into a host.
ismodifyservice [-M system name] -r -h host name [-p port number] NS|IR
The addition of WWW service
ismodifyservice [-M system name] -a IPP WWW server discernment name
Environmental definition file name
Deletion of a WWW server
ismodifyservice [-M system name] -d IPP WWW server discernment name
Description
The ismodifyservice command is a command which performs the following operations to the specified
service.
•
Addition of a service
•
Naming Service, reference location change of Interface Repository (standard interface/value
interface)
•
Deletion of a server
The services which can be operated with this command are as follows.
•
Interface Repository (standard interface)
•
Interface Repository (value interface)
•
Naming Service
•
Event Service
•
Servlet Service
•
CORBA/Client Client Gateway
1-15
Chapter 1: Interstage Setup Commands
•
Interstage HTTP Server (Enterprise Edition and Standard Edition only)
•
WWW Server
When a service is added using this function, the tuning value of the service is customized according to
the system scale currently set up.
The arguments for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-a
Specify when adding a service or when changing the Naming Service and the reference location of the
Interface Repository (standard interface/value interface) to a local host.
-r
Specify when changing the Naming Service and the reference location of the Interface Repository
(standard interface) to a remote host.
-d
Specify when deleting a service.
-h host name
Specify the host name changed at the time of -r option specification.
-p port number
Specify the port number changed at the time of -r option specification. When this is omitted, it is
assumed that 8002 was specified.
Service discernment name
Specify the discernment name of the service added, changed or deleted. The discernment name of
each service is as follows. There is no distinction between uppercase and lowercase.
Service
Discernment name
Interface Repository (Standard interface/value
interface)
IR
Naming Service
NS
Event Service
ES
IPP
WWW Server
1-16
Servlet Service
EVENT
CORBA/SOAP client gateway
SOAPCLGW
ismodifyservice
Service
Discernment name
Interstage HTTP Server (Enterprise Edition and
Standard Edition only)
FJapache
WWW server discernment name / Environmental definition file name
At the time of adding a WWW server, the WWW server environmental definition file name and
discernment name are specified. Only the discernment child of a WWW server is specified at the time
of deleting a WWW server.
A discernment name needs to specify by the arbitrary alphanumeric characters of less than eight
characters.
The environmental definition file name of a WWW server specifies only a file name.
The environmental definition file name of a WWW server specified with a full path.
Notes
•
Only system administrators are authorized to execute this command.
•
Multi-execution of this command is not possible.
•
This command cannot be used if the following services have been set up in the environment.
•
•
−
Load Balance Option
−
Database Linkage Service
This command cannot be executed in the following circumstances:
−
When any Interstage services are operating
−
When any of the isgendef, isregistdef, isstart, isstop or isstat commands are being executed
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
1-17
Chapter 1: Interstage Setup Commands
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
webgw_stop
odsetlbo
odstartlbo
odstoplbo
jssvstart (*)
jssvstop (*)
soapgwstartclge (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Cache_s
InterfaceRep_Cache_e
OD_stop
apachectl
1-18
•
This command cannot be executed when the service on which the service to be added/deleted
depends does not exist.
•
This command cannot be executed if Interstage initialization has not completed.
•
The operation type is changed to TYPE3 when either the Naming Service or Interface Repository
(or both) are remote.
•
The operation type is changed to TYPE1 when both the Naming Service and Interface Repository
become the local reference.
•
The Interface Repository (value interface) is set up automatically when the Interface Repository is
set up locally and the Naming Service is a local reference.
•
When the Event Service is used, use the esmkchnl command to create the event channel and then,
before initializing Interstage, use the esrmchnl command to delete the created event channel.
Refer to the esrmchnl command in Chapter 16.
ismodifyservice
•
•
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterFaceRep_Cache Service)
−
Interface Repository (InterFaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (INTERSTAGE JServlet) (*)
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
−
Interstage HTTP Server (*)
The Interstage HTTP Server cannot be added to or deleted from an extended system. (Enterprise
Edition only)
Example
For the addition of an Event Service:
ismodifyservice –s ES
When the reference place of naming service is changed:
imodifyservice –r –h host01 NS
1-19
Chapter 1: Interstage Setup Commands
When there is an addition to the WWW Server:
ismodifyservice –a IPP WWWSV WWWSV.dat
For the deletion of a WWW Server:
ismodifyservice –d IPP WWWSV
1-20
isresetservice
isresetservice
Name
isresetservice
This command restores the environment where it was set up, immediately after Interstage installation.
Synopsis
isresetservice
Description
This command restores the environment where it was set up, immediately after Interstage installation.
Notes
•
•
•
The following services need to be installed:
−
CORBA Service
−
Component Transaction Service
−
Interstage EJB Service
−
WWW Server
−
J2EE
−
XML
This command clears the environment definition used in the services indicated below. It is
recommended to back up resources as required. For backup information, refer to Backing Up and
Restoring Resources in the Interstage Operator's Guide.
−
CORBA Service
−
Component Transaction Service
−
Interstage EJB Service
−
Servlet Service
−
WWW Server.
When this command is used for Plus, the Portalworks system definition is cleared. For details on
how to restore data, see Simple Setup to EJB and Limitation at Using isresetservice Command in
Restriction in the Portalworks Administrator's Guide.
Example
isresetservice
1-21
Chapter 1: Interstage Setup Commands
isregistdef
Name
isregistdef
Generates an Interstage operating environment definition.
Synopsis
Isregistdef [-M system-name]
Description
This command generates a definition for each service, and an Interstage operating environment
definition, based on the Interstage System Definition generated by the isgendef command.
The options and arguments for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
The Interstage operating environment definition is stored in the following file:
C:\INTERSTAGE\td\etc\isreg\isinitdef.txt
/opt/FSUNtd/etc/isreg/isinitdef.txt
/opt/FJSVtd/etc/isreg/isinitdef.txt
Notes
1-22
•
Only system administrators are authorized to execute this command.
•
Before executing this command, stop Interstage.
•
Following installation, the isgendef command must be executed before isregistdef.
•
After executing this command, initialize Interstage with the isinit command. If the definition is
changed after executing this command, re-initialize Interstage.
isregistdef
•
•
The following assumptions are made while registering the definition of each service with the
isregistdef command. When customizing the system, modify the definition of each service before
executing the isinit command.
−
All services configured are operating.
−
The number of server applications running is one tenth of the maximum number of client
connections, and that any server can also be used as a client.
−
The Database Linkage Service has 5 levels.
−
The Resource Manager has 6 levels.
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
webgw_stop
odsetlbo
odstartlbo
odstoplbo
jssvstart (*)
jssvstop (*)
soapgwstartclge (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Cache_s
InterfaceRep_Cache_e
1-23
Chapter 1: Interstage Setup Commands
OD_stop
apachectl
•
1-24
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterFaceRep_Cache Service)
−
Interface Repository (InterFaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (Interstage JServlet) (*)
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
−
Interstage HTTP Server (*)
isstart
isstart
Name
isstart
Starts Interstage.
Synopsis
Isstart [-M system-name]
Description
This command starts Interstage.
Interstage must be initialized using the isinit command, before starting it with the isstart command.
The isstart command starts all services related to the operation type specified for initialization in the isinit
command. isstart does not start a service mentioned in isstart if it has already been started. If isstart
fails to start a service due to an error, isstart terminates all of the services and returns.
The options for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only system administrators are authorized to execute this command.
•
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
1-25
Chapter 1: Interstage Setup Commands
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
webgw_stop
odsetlbo
odstartlbo
odstoplbo
jssvstart (*)
jssvstop (*)
soapgwstartclge (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Cache_s
InterfaceRep_Cache_e
OD_stop
apachectl
•
1-26
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterFaceRep_Cache Service)
−
Interface Repository (InterFaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (INTERSTAGE JServlet) (*)
isstart
•
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
−
Interstage HTTP Server (*)
When running EJB applications in a WorkUnit, it is necessary to set environment variables before
running the isstart command. For environment variable information, refer to the J2EE User’s Guide.
1-27
Chapter 1: Interstage Setup Commands
isstat
Name
isstat
Displays the Interstage starting status.
Synopsis
Isstat [-M system-name]
Description
This command displays the current status of Interstage, and the starting status of each service which
configures the application format and the starting status of the WWW server initialized by the isinit
command.
Either the execution status (of the running services) or the stop status is displayed.
If isinit command initialization has not completed, isstat terminates abnormally. The options for this
command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
The services and WWW server names displayed by isstat are as follows:
1-28
•
Object Director (CORBA Service)
•
Naming Service
•
NSLoadBalancingOption
•
InterfaceRepositoryCacheService (Standard interface)
•
InterfaceRepositoryCacheEService (Value interface)
•
Event Service
•
TransactionDirector (Component Transaction Service)
•
Object Transaction Service (Database Linkage Service)
•
Servlet
•
WebGateway (HTML Page Editing Service)
isstat
•
WebServer (WWW Server Service)
−
Web1 (ID)
•
CORBA/SOAP Client Gateway
•
FJapache (Interstage HTTP Server) Enterprise Edition and Standard Edition only
−
DEFAULT (ID)
For a WWW server operated with a WWW server service, an identifier specified at initialization of
Interstage is displayed. For a WWW server operated with Interstage HTTP Server, "DEFAULT" is
displayed as an identifier.
The services names displayed by isstat are as follows:
•
Object Director (CORBA Service)
•
Naming Service
•
NSLoadBalancingOption
•
InterfaceRepositoryCacheService (Standard interface)
•
InterfaceRepositoryCacheEService (Value interface)
•
Event Service
•
TransactionDirector (Component Transaction Service)
•
Object Transaction Service (Database Linkage Service)
•
Servlet
•
CORBA/SOAP Client Gateway
•
FJapache (Interstage HTTP Server) Enterprise Edition and Standard Edition only
−
DEFAULT (ID)
For a WWW server operated with Interstage HTTP Server, "DEFAULT" is displayed as an identifier.
Notes
•
Only system administrators are authorized to execute this command.
•
When the setup mode of Database Linkage Service has turned into the mode which employs only a
resource control manager, the state of "ObjectTransactionService" is set to "stop" regardless of the
employment state of Interstage or a resource control program.
•
When this command is executed, message od15500 may be output without any consequences.
Re-execute the command.
1-29
Chapter 1: Interstage Setup Commands
Example
Isstat
SERVICE NAME
STATUS
ObjectDirector
execute
NamingService
execute
NS LoadBalancingOption
execute
InterfaceRepositoryCacheService
execute
InterfaceRepositoryCacheEService
execute
EventService
execute
TransactionDirector
execute
ObjectTransactionService
execute
Servlet
execute
WebGateway
execute
WebServer
Web1
execute
Web2
execute
CORBA/SOAP Client
execute
FJapache
DEFAULT
1-30
execute
isstat
isstat
SERVICE NAME
STATUS
ObjectDirector
execute
NamingService
execute
NS LoadBalancingOption
execute
InterfaceRepositoryCacheService
execute
InterfaceRepositoryCacheEService
execute
EventService
execute
TransactionDirector
execute
ObjectTransactionService
execute
Servlet
execute
CORBA/SOAP Client
execute
FJapache
DEFAULT
execute
1-31
Chapter 1: Interstage Setup Commands
isstop
Name
isstop
Stops Interstage
Synopsis
isstop [-M system-name] [-c|-f]
Description
This command stops Interstage. This command stops the services initialized by the isinit command.
The services stopped by this command change with the options specified.
Specify the -c or -f options to forcibly stop it.
The options of this command are as follows:
- no option
The Component Transaction Service, Database Linkage Service, and resource control program are
stopped normally.
The WWW Server, Servlet Service, HTML Page Editing Service and CORBA/SOAP Client Gateway are
forcibly stopped.
The HTML Page Editing Service is supported only for Enterprise Edition and the Standard Edition of
Windows(R) and Solaris(TM) Operating Environment editions.
In this document, Solaris(TM) Operating Environment is hereafter abbreviated as Solaris OE.
-M system-name
Specify the name of the target system.
-c
Forcibly terminate active services.
This option forcibly stops all of the services started with the isstart command. On terminating the TD, it
also stops all active WorkUnits. Regardless of the transactions being processed, it forcibly stops the
Database Linkage Service and the Resource Manager. Therefore, if any in-doubt transactions exist
while restarting the resource control program after forcible termination, perform the recovery process.
The WWW Server, Servlet Service, HTML Page Editing Service , CORBA/SOAP Client Gateway and
Interstage HTTP Server are forcibly stopped.
The HTML Page Editing Service is supported only for Enterprise Edition and the Standard Edition of
Windows(R) and Solaris OE editions. The Interstage HTTP Server is applicable only for the Enterprise
Edition and Standard Edition.
1-32
isstop
-f
Forcibly terminate all services.
This option forcibly terminates all active WorkUnits, the Resource Manager, and all of the Interstage
services (CORBA Service, naming Service, Interface Repository, Event Service Component
Transaction Service, Database Linkage Service, WWW Server, Servlet Service, HTML Page Editing
Service, Load Balance Option CORBA/SOAP Client Gateway and Interstage HTTP Server).
The HTML Page Editing Service is supported only for Enterprise Edition and the Standard Edition of
Windows(R) and Solaris OE editions. The Interstage HTTP Server is applicable only for Enterprise
Edition and Standard Edition. The load balance option is only applicable to Enterprise Edition.
Notes
•
Only system administrators are authorized to execute this command.
•
New transactions cannot be performed by the Database Linkage Service or Resource Manager if
services have been terminated with this command.
•
Only transactions being terminated (commit/rollback) can be completed, as follows.
Database Linkage Service
A new begin issued by the client application terminates abnormally, however, if begin has already
been issued, commit/rollback succeeds.
Resource Manager
Commit/rollback to be issued by the client application terminates abnormally, however, if two-phase
commit has been issued in the resource control program, commit succeeds.
•
When using this command, don't execute the command shown below to initialized service with an
Interstage integrated command or a operation tool. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
otssetup
otsmklog
tdsetup
tdunsetup
tdstart
tdstop
otsstart
otsstop
essetup
esunsetup
esstart
esstop
ippstart (*)
ippstop (*)
ipprestart (*)
webgw_start
webgw_stop
odsetlbo
odstartlbo
odstoplbo
1-33
Chapter 1: Interstage Setup Commands
jssvstart (*)
jssvstop (*)
soapgwstartclge (*)
soapgwstopclgw (*)
odadmin_ex
ippstartsv
ippstopsv
ippsetstartup
odadmin
S99startod
CosNaming_s
InterfaceRep_Cache_s
InterfaceRep_Cache_e
OD_stop
apachectl
1-34
•
To terminate Interstage in full forced termination mode, first close all services that comprise
Interstage, then execute the isstop command.
For example, because the Systemwalker CentricMGR operation management server assumes
control for the running of the CORBA Service and Naming Service, the isstop command must be
executed after stopping the Systemwalker CentricMGR operation management server.
•
Do not use the start/stop commands of the following services using the Control Panel or the net
start/net stop commands while using this command. However, when "mode2" is specified to be the
operation state surveillance mode ("IS Monitor Mode") of an Interstage operation environment
definition and service is being initialized about a command with the following (*), it can perform.
−
CORBA Service (OD_start)
−
Naming Service (Naming Service)
−
Interface Repository (InterfaceRep_Cache Service)
−
Interface Repository (InterfaceRep_Cache_e Service)
−
Event Service (EventService)
−
Component Transaction Service (Transaction Director)
−
Database Linkage Service (Object TransactionService)
−
Interstage API Service (INTERSTAGE API)
−
Load Balancing Option (NS LoadBalancingOption)
−
WWW Server Service (F3FMwww) (*)
−
HTML Page Editing Service (WebGateway)
−
Servlet Service (INTERSTAGE JServlet) (*)
−
CORBA/SOAP Client Gateway (CORBA_SOAP ClientGW) (*)
isstop
−
•
Interstage HTTP Server (*)
When this command is executed, message od15500 may be output without any consequences.
Re-execute the command.
1-35
Chapter 1: Interstage Setup Commands
1-36
Chapter 2
Interstage Operation Tool Commands
This chapter describes the Interstage Operation Tool commands.
Note
The Interstage operation tool command is available for the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition.
Note
Only the following commands are available for the Web-J Edition of the Linux system. (All commands
cannot be used in the Windows(R) and Solaris OE systems.)
•
Interstage
•
S99FJSVwgui.
2-1
Chapter 2: Interstage Operation Tool Commands
isstartoptool
Name
isstartoptool
Starts the Interstage Operation Tool.
Synopsis
isstartoptool [-M system-name]
Description
This command starts the Interstage Operation Tool.
The option of this command is as follows:
-M system-name
When an extended system is generated, the system name set as the object of employment is specified.
If this option is omitted, employment by the default system will apply.
Notes
2-2
•
Only the superuser can execute this command.
•
Before executing this command, check the following items:
−
"LANG" was not specified to be /etc/default/init or "C" is set as "LANG".
−
Environment variable "LANG" of the user who starts an Interstage employment operation tool
was not specified, or "C" is set as "LANG".
•
When operating SOAP service from an Interstage operation tool, a setup of an environment
variable is required before this command execution.
Refer to Setup of an Environment Variable in the SOAP Service User's Guide for details of the
environment variable to set up.
•
Before using this command to start the Interstage operation manipulation tools for the extended
system, use the iscreatesys command to generate an extended system.
•
If a system name is specified in environment variable "IS_SYSTEM" before executing this
command without the -M option, the tools can be started for the system specified in environment
variable "IS_SYSTEM". When the -M option and the environment variable are specified at the
same time, the -M option is enabled.
isstopoptool
isstopoptool
Name
isstopoptool
Stops the Interstage Operation Tool.
Synopsis
isstopoptool [-M system-name]
Description
This command stops the Interstage Operation Tool.
The option of this command is as follows:
-M system-name
When an extended system is generated, the system name set as the object of employment is specified.
If this option is omitted, employment by the default system will apply.
Notes
•
Only the superuser can execute this command.
•
If a system name is specified in environment variable "IS_SYSTEM" before executing this
command without the -M option, the tools can be started for the system specified in environment
variable "IS_SYSTEM". When the -M option and the environment variable are specified at the
same time, the -M option is enabled.
2-3
Chapter 2: Interstage Operation Tool Commands
isstatoptool
Name
isstatoptool
Starting state display of the Interstage Operation Tool.
Synopsis
isstatoptool [-M system-name]
Description
This command Starting state display of the Interstage Operation Tool.
The option of this command is as follows:
-M system-name
When an extended system is generated, the system name set as the object of employment is specified.
If this option is omitted, employment by the default system will apply.
Notes
2-4
•
Only the superuser can execute this command.
•
When displaying the starting state of the Interstage operation tool of an extended system by this
command, the iscreatesys command needs to generate an extended system.
•
If a system name is specified in environment variable "IS_SYSTEM" before executing this
command without the -M option, the tools can be started for the system specified in environment
variable "IS_SYSTEM". When the -M option and the environment variable are specified at the
same time, the -M option is enabled.
issetupoptool
issetupoptool
Name
issetupoptool
The environmental definition of an Interstage operation tool of operation
Synopsis
issetupoptool [-M system-name] [-p port number]
Description
This command Starting state display of the Interstage Operation Tool.
The options of this command are as follows:
-M system-name
When an extended system is generated, the system name set as the object of employment is specified.
If this option is omitted, employment by the default system will apply.
-p port number
The port number for using an Interstage operation tool is specified. A port number is changed into the
value specified by this option when updating the definition file of the WWW server which a default
system or an extended system already uses.
When omitted, the following values are set up by the existence of a WWW server.
When already created: The previously set-up port number is maintained.
When newly created: The following values are set up.
−
default system : 12000
−
extended system : 12001
2-5
Chapter 2: Interstage Operation Tool Commands
Notes
2-6
•
Only the superuser can execute this command.
•
When displaying the starting state of the Interstage operation tool of an extended system by this
command, the iscreatesys command is needed to generate an extended system.
•
If a system name is specified in environment variable "IS_SYSTEM" before executing this
command without the -M option, the tools can be started for the system specified in environment
variable "IS_SYSTEM". When the -M option and the environment variable are specified at the
same time, the -M option is enabled.
•
In installing and uninstalling SOAP service, please execute this command again after stopping the
WWW server.
•
The definition file of the WWW server edited by this command is generated by the following
directories.
default system :
/etc/opt/FJSVisgui/FJSVisgui.dat
extended system : /var/opt/FJSVisas/system/system name/FJSVisgui/etc/FJSVisgui.dat
interstage
interstage
Name
interstage
Starts and terminates Interstage
Synopsis
/etc/rc.d/init.d/interstage
start|stop
Description
This command starts or terminates the following services:
•
WWW server for the Interstage Operation Tool
•
WWW server (Interstage HTTP server)
•
Servlet Service
This command is started as a system initialization script or system shut down script at system startup.
The parameters of this command are as follows:
start
Starts the WWW server for the Interstage Operation Tool, the WWW server of the Interstage HTTP
server, and the Servlet Service.
stop
Terminates the WWW server for the Interstage Operation Tool, the WWW server of the Interstage HTTP
server, and the Servlet Service.
2-7
Chapter 2: Interstage Operation Tool Commands
Notes
•
Only a superuser can execute this command.
•
Only Web-J Edition can be used for this command.
•
This command starts or terminates the WWW server that the Servlet Service uses.
•
When executing the WWW server as a system initialization script or shut down script, include the
comment about apachectl command execution for “starting of WWW server” and ”terminating of
WWW server” as shown in the following example script.
:
start)
:
# The start of the WWW server.
<WWW server install directory>/bin/apachectl start
:
stop)
:
# The stop of the WWW server.
<WWW server install directory>/bin/apachectl stop
:
Examples
When starting Interstage
# /etc/rc.d/init.d/interstage
start
When terminating Interstage
# /etc/rc.d/init.d/interstage
2-8
stop
S99FJSVwgui
S99FJSVwgui
Name
S99FJSVwgui
Starts and terminates the WWW server for the Interstage Operation Tool.
Synopsis
/opt/FJSVwgui/gui/bin/S99FJSVwgui
start|stop
Description
This command starts or terminates the Interstage Operation Tool.
This command is started as a system initialization script or system shut down script at system startup.
The parameters of this command are:
start
Starts the Interstage Operation Tool.
stop
Terminates the Interstage Operation Tool.
Notes
•
Only a superuser can execute this command.
•
Only Web-J Edition can be used for this command.
•
The log file and the trace log file are stored under the following directory:
/var/opt/FJSVwgui/trc
2-9
Chapter 2: Interstage Operation Tool Commands
Examples
When starting the Interstage Operation Tool
# /opt/FJSVwgui/gui/bin/S99FJSVwgui
start
When terminating the Interstage Operation Tool
# /opt/FJSVwgui/gui/bin/S99FJSVwgui
2-10
stop
Part 2
J2EE Edition
Chapter 3
J2EE Operation Commands
This chapter describes the J2EE operation commands.
Notes
The J2EE operation command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
3-1
Chapter 3: J2EE Operation Commands
ijsdeployment
Name
ijsdeployment
J2EE deployment command
Synopsis
ijsdeployment -n name -f filepath [-r]
Description
The ijsdeployment command deploys a J2EE application to an IJServer WorkUnit.
The options and arguments of the ijsdeployment command are explained below:
-n name
Specifies the name of the IJServer WorkUnit to which deployment is to be performed.
-f filepath
Specifies the file to be deployed.
The following types of files can be deployed:
•
ear file
•
war file
•
EJB-JAR file
•
rar file
-r
Specifies that the specified application be written and deployed over an existing application.
Command Environment Setup File
This environment setup file is used to define information required for following command operation.
•
ijsdeployment
•
ijsundeployment
•
ijslistapl
The operation by this command is processed with the Interstage JMX service used as the execution
base of an Interstage Management Console. Refer to the Operator's Guide for information about an
environment setup of Interstage JMX service.
Basically, the environment setup file need not be modified.
If modification is needed, use an editor to edit the file.
3-2
ijsdeployment
The edited information becomes effective from the next execution.
Location of Command Environment Setup File
The location and name of the environment setup file are as follows:
/opt/FJSVj2ee/etc/ijscomprop.conf
Definitions in the Command Environment Setup File
The table below provides a summary of the definitions in the command environment setup file:
Key
Explanation
Default
java.home
Specifies the path of the JDK/JRE installation
directory when changing the JavaVM to be
used by the command. The command
executes the following command in the
specified directory:
The JavaVM to be used is
determined according to the path
environment variable.
bin/java
java.maxMemory
Specifies the maximum size (MB) of memory to
be allocated to the JavaVM that is started in an
extension of command execution.
It operates by 512.
Example of Definition in Command Environment Setup File
An example of the definition in the command environment setup file is shown below.
Use the "key=value" format and delimit each statement with a linefeed.
Place "#" at the beginning of a comment line.
If the value of a definition item is invalid, the default is used for operation.
# Interstage J2EE Deployment Command Configuration file
java.home=/opt/FJSVawjbk/jdk13
*1 Specify this value properly according to the
environment.
java.maxMemory=512
3-3
Chapter 3: J2EE Operation Commands
Return Value
0: Normal end
Other than the above: An error occurred and processing was interrupted.
Note
•
Only a user with administrator authority can execute this command.
•
To use the command, an Interstage JMX service must be installed and started in advance on the
machine on which the command is to be executed.
•
To execute this command, the deployment target IJServer WorkUnit must be created in advance on
the machine on which the command is to be executed. Use the Interstage Management Console
to create the deployment target IJServer WorkUnit.
•
Before the command is executed, the target IJServer WorkUnit must be stopped.
•
Only an IJServer WorkUnit created using the Interstage Management Console can be a
deployment target WorkUnit for the command.
•
The command can be executed when Interstage is active or when it is stopped in mode other than
the all forced stop mode.
•
JavaVM used by deployment processing is JavaVM which Interstage JMX service uses instead of
JavaVM specified by the command environment setup file.
Example
The following example of the command assumes that the IJServer WorkUnit name is IJServer001 and
the file path is /usr/tmp/sample.ear:
ijsdeployment -n IJServer001 -f /usr/tmp/sample.ear
3-4
ijsundeployment
ijsundeployment
Name
ijsdeployment
J2EE undeployment command
Synopsis
ijsundeployment -n name -k kind -a application ...
ijsundeployment -n name –f
Description
The ijsundeployment command undeploys the application that was previously deployed to an IJServer
WorkUnit.
The options and arguments of the ijsundeployment command are explained below:
-n name
Specifies the IJServer WorkUnit to which the application to be undeployed is deployed.
-k kind
Specifies the type of the application to be undeployed.
The following types can be specified:
•
ejb: EJB application
•
web: Web application
This option cannot be specified together with the -f option.
-a application
Specifies the name of the application to be undeployed.
Two or more application names can be specified by delimiting them with a blank if they are the same
type of application.
This option cannot be specified together with the -f option.
-f
This command undeploys the all applications that was deployed to the target IJServer WorkUnit.
This option cannot be specified together with the -k and -a option.
3-5
Chapter 3: J2EE Operation Commands
Command Environment Setup File
This environment setup file is used to define information required for following command operation.
Basically, the environment setup file need not be modified.
For more information, refer to the ijsdeployment command.
Return Value
0: Normal end
Other than the above: An error occurred and processing was interrupted.
Note
•
Only a user with administrator authority can execute this command.
•
To use the command, an Interstage JMX service must be installed and started in advance on the
machine on which the command is to be executed.
•
Before the command is executed, the target IJServer WorkUnit must be stopped.
•
Only an IJServer WorkUnit created using the Interstage Management Console can be a
deployment target WorkUnit for the command.
•
The command can be executed when Interstage is active or when it is stopped in mode other than
the all forced stop mode.
Example
The following example of the command assumes that the IJServer WorkUnit name is IJServer001, the
application type is EJB, and the application name is sampleEJB:
ijsundeployment -n IJServer001 -k ejb -a sampleEJB
3-6
ijslistapl
ijslistapl
Name
ijslistapl
lists the applications deployed
Synopsis
ijslistapl [-n name]
Description
The ijslistapl command lists the applications deployed to an IJServer WorkUnit.
The options and arguments of the ijslistapl command are explained below:
n name
Specifies the target IJServer WorkUnit.
If this option is omitted, the command outputs information on all IJServer WorkUnits.
Command Environment Setup File
This environment setup file is used to define information required for following command operation.
Basically, the environment setup file need not be modified.
For more information, refer to the ijsdeployment command.
Return Value
0: Normal end
Other than the above: An error occurred and processing was interrupted.
Note
•
Only a user with administrator authority can execute this command.
•
To use the command, an Interstage JMX service must be installed and started in advance on the
machine on which the command is to be executed.
•
Only an IJServer WorkUnit created using the Interstage Management Console can be a
deployment target WorkUnit for the command.
3-7
Chapter 3: J2EE Operation Commands
Example
The following example of the command assumes that the IJServer WorkUnit name is IJServer001:
>ijslistapl –n IJServer001
** IJServer001 **
kind
name
EJB
ejbsample001
EJB
ejbsample 002
Web
websample001
Web
websample002
The EJB and Web applications that are deployed to the specified IJServer WorkUnit are listed
respectively in ascending order.
The example at the time of omitting the WorkUnit name of IJServer is shown below.
>ijslistapl
** IJServer001 **
kind
name
EJB
ejbsample001
Web
websample001
** IJServer002 **
kind
name
EJB
ejbsample002
Web
websample002
...
The IJServer WorkUnit are listed respectively in ascending order.
The EJB and Web applications that are deployed to the IJServer WorkUnits are also listed respectively
in ascending order in units of IJServer WorkUnits.
3-8
Chapter 4
Servlet Service Operation Commands
This chapter describes the operating commands provided by the Servlet Service. The operating
commands are located in the following directory:
/opt/FJSVjs2sr/bin
Notes
The Servlet service operation commands can be used only when the following product running on the
Solaris OE system uses an old version (V5.1 or earlier) of the Servlet service.
•
Interstage Application Server Enterprise Edition
4-1
Chapter 4: Servlet Service Operation Commands
jssrs_start
Name
jssrs_start
Starting the Session Registry Server.
Synopsis
jssrs_start
Description
This command can be used only the following product, using an V5.1 or earlier version of Servlet
service.
•
Interstage Application Server Enterprise Edition
The jssrs_start command starts the SessionRegistry server.
This command also allows the user to tune the SessionRegistry server using the following environment
variables. Set these variables as required.
Table 4-1 SessionRegistry Environment Variables
4-2
Definition name
Explanation
Default value
JAVA_HOME
Specifies the absolute path to the desired Java
execution environment.
/opt/FJSVawjbk/jdk13
JSSRS_JAVAPARAM
Specifies the initial value and maximum size of the
pool size to be allocated in memory for the Java
execution environment.
-Xms32m -Xmx256m
JSSRS_TIMEOUT
Specifies a wait time for return after an operation
command is executed.
30
jssrs_start
Messages
Result of execution of this command is output on the display on which the command is executed. For
the contents of the messages, refer to the Messages. Detailed log information is output to the log file
(/var/opt/FJSVjs2sr/log/jssr0_p.log) when errors occur.
Notes
•
Only Interstage Application Server Enterprise Edition can be used for this command.
•
Only the super user is authorized to execute this command.
•
Use JDK 1.3.
Example
jssrs_start
4-3
Chapter 4: Servlet Service Operation Commands
jssrs_stop
Name
jssrs_stop
Stopping the SessionRegistry server.
Synopsis
jssrs_stop
Description
This command can be used only the following product, using an old version Servlet service.
•
Interstage Application Server Enterprise Edition
The jssrs_stop command stops the SessionRegistry server.
Messages
Result of execution of this command is output on the display on which the command is executed. For
the contents of the messages, refer to the Messages. Detailed log information is output to the log file
(/var/opt/FJSVjs2sr/log/jssr0_p.log) when errors occur.
Notes
•
Only Interstage Application Server Enterprise Edition can be used for this command.
•
Only the super user is authorized to execute this command.
•
Use JDK 1.3.
Example
jssrs_stop
4-4
jssrs_ clean
jssrs_ clean
Name
jssrs_clean
Releasing the SessionRegistry server resources.
Synopsis
jssrs_clean
Description
This command can be used only the following product, using an old version Servlet service.
•
Interstage Application Server Enterprise Edition
The jssrs_clean command releases the resources used by the SessionRegistry server.
When SessionRegistry server terminates abnormally (including forced termination), the resources used
by the server may remain in memory. This command can release such resources to restore memory to
the normal state from the SessionRegistry server operation.
Messages
Result of execution of this command is output on the display on which the command is executed. For
the contents of the messages, refer to the Messages.
Notes
•
Only Interstage Application Server Enterprise Edition can be used for this command.
•
Only the superuser is authorized to execute this command.
•
Use JDK 1.3.
Example
jssrs_clean
4-5
Chapter 4: Servlet Service Operation Commands
4-6
Chapter 5
EJB Service Operation Commands
This chapter describes the commands used for operating the EJB Service.
The EJB Service operation commands can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition.
All operations in Interstage Version 6.0 can be executed from the Interstage Management Console.
The following commands are available in Interstage Version 6.0:
•
ejbcustx
•
ejbdefexport
•
ejbdefimport
•
ejbdbdefexport
•
ejbdbdefimport
5-1
Chapter 5: EJB Service Operation Commands
ejbmakeapfolder
Name
ejbmakeapfolder
Creates and modifies Application Folders.
Synopsis
ejbmakeapfolder [-M system name] Application Folder
Description
Creates and modifies Application Folders.
The arguments for this command are as follows:
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
Application Folder
Specify the full path of the Application Folder.
The path may be up to 127 bytes long. Do not specify blanks.
Notes
•
5-2
After Interstage is installed create the application folder. In the following conditions, the application
folder is created automatically at installation:
−
When the automatic setup of the simple installation for Standard Edition or Enterprise Edition
is executed.
−
When Plus is installed.
•
Create Application Folders on the hard disk of the device in which Interstage is installed.
•
New or unused folders may be used as Application Folders.
•
All EJB applications must be stopped before Application Folders are modified.
•
Make Application Folders invalid before modifying the folders.
•
Do not use this command while customizing EJB application definitions, installing/uninstalling EJB
applications, or running EJB applications.
•
Do not use this command while an ejbmakeapfolder command is being executed.
ejbmakeapfolder
Example
ejbmakeapfolder c:\ejb001
ejbmakeapfolder /ejb/ejb001
5-3
Chapter 5: EJB Service Operation Commands
ejbmakecontainer
Name
ejbmakecontainer
Create an EJB container.
Synopsis
ejbmakecontainer [-e] [-y] [-M system name] EJB container definition file
name
Description
This command creates an EJB container.
If the EJB container has already been defined, the following confirmation message is output.
To overwrite it, enter y. Selecting n cancels the command.
The following EJB container has already been created.
EJB container name
If the process continues, the above EJB container information will be deleted once.
Are you sure to continue the EJB container creation? (y/n)
The arguments of the ejbmakecontainer command are described below.
-e
Registers an EJB container forcibly.
The EJB container is registered forcibly in cases where a standard registration process fails. However,
the EJB container may not be registered if the registration process fails while the CORBA service is not
running or if the registration process fails because the system has a problem.
-y
Defines or overwrites the EJB container without outputting the confirmation message.
-M system name
To operate the extended system, specify the system name specified in the iscreatesys command for this
option. If this option is omitted, the default system name is specified.
EJB container definition file name
Specifies a path (relative path or absolute path) of the EJB container definition file. For information
about the definition file, refer to the J2EE User's Guide.
5-4
ejbdelcontainer
ejbdelcontainer
Name
ejbdelcontainer
Delete the EJB container.
Synopsis
ejbdelcontainer [-e] [-y] [-M system name] [-a | EJB container name]
Description
This command deletes EJB containers. The following confirmation message is output. Selecting y
deletes the specified EJB containers. Selecting n cancels the command.
Are you sure to delete the specified EJB container? (y/n)
The arguments of the ejbdelcontainer command are described below.
-e
Deletes an EJB container forcibly. The EJB container is deleted forcibly in cases where a standard
delete process fails. However, the EJB container may not be deleted if the delete process fails while the
CORBA service is not running or if the delete process fails because the system has a problem.
-y
Deletes an EJB container without outputting the confirmation message. The specified EJB container or
all EJB containers are uninstalled without the confirmation message is output.
-M system name
To operate the extended system, specify the system name specified in the iscreatesys command for this
option. If this option is omitted, the default system name is specified.
-a
Deletes all EJB containers. It is not required to specify the EJB container name.
When the -a option is specified, the following confirmation message is output. Selecting y deletes all
EJB containers. Selecting n cancels the command.
Are you sure to delete all EJB containers? (y/n)
EJB container definition file name
Specify the name of the EJB container to be deleted.
5-5
Chapter 5: EJB Service Operation Commands
Message
When an EJB application has been deployed to the EJB container to be deleted, the following message
is output. To continue the process, select y. To cancel the process, select n.
The following EJB application has been deployed on the EJB container.
[Displays the name of installed EJB application.]
When the process is continued, the EJB application is deleted.
Are you sure to continue the EJB container deletion? (y/n)
5-6
ejbinstalleb
ejbinstalleb
Name
ejbinstalleb
Installs EJB applications in Application Folders.
Synopsis
ejbinstalleb [-e] [-s EJB container name] [-N] [-y] [-t initial thread
concurrency] [-d -h hostname] [-p port number] [-r] [-M system name]
[install-source-folder]
Description
Installs EJB applications in an Application Folder.
The arguments for this command are as follows:
-e
Forcibly installs EJB applications.
If normal installation fails, forced installation can be performed. However, forced installation may also
fail if the CORBA Service has not been activated or if there are system problems.
-s EJB container name
This specifies the name of the EJB container to which the EJB application is installed.
-N
Does not register the EJB application name in the Naming Service.
Use the OD_or_adm command to register EJB application names in the Naming Service. Refer to the
OD_or_adm command in Chapter 14 for details.
-y
Installs without outputting a confirmation message.
If previously installed EJB applications are included, this argument installs over the applications without
outputting a confirmation message.
-t initial thread concurrency
Specifies the EJB application initial thread concurrency.
If this specification is omitted, 16 is set.
You can specify this argument with or without a blank between the "t" and the initial thread concurrency.
This parameter can be set to a value in the range of 1 to 2147483647. If the max_exec_instance
parameter in the CORBA Service operating environment file (config) is set to a higher value, the
activation of the EJB application will fail. In the case of a STATELESS Session Bean, set the value to 64
or less.
5-7
Chapter 5: EJB Service Operation Commands
This option cannot be specified with the -s option.
-d
Specify this when load balance, which uses TrafficDirector, is used.
-h hostname
Specify the hostname when load balance, which uses TrafficDirector, is used.
The hostname to be specified differs depending on the type of load balance.
In case of load balance on each method invocation: The hostname of the virtual IP address.
In case of load balance of the Naming Service: The hostname of the Server (The Server that is
executing the command).
-p port number
Specify the port number when load balance, which uses TrafficDirector, is used.
The port number can be set to a value in the range of 1 to 65536.
If it is omitted, set 8002. It does not matter whether or not there is a blank between "-p" and the port
number.
-r
Installs the application using the same folder structure as that of the previous application folder.
Specify the previous application folder for the installation source directory name. If the EJB application
has never been installed, it is installed into the specified EJB container. If the EJB container has been
previously installed, it is installed into the same EJB container as previously.
To specify this option, the EJB container must be created.
The EJB application that has already been installed in an EJB container cannot be installed into another
EJB container.
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
install-source-folder
Specifies the work area in which the Deployment Tool expands the EJB application. The default is the
current folder.
Notes
5-8
•
When the J2EE Deployment Tool of Interstage V5 is used, there is no need to execute this
command. This command is for EJB application tuning by setting the load balance or the number
of multiple threads.
•
Do not use this command while customizing the relevant EJB application definitions,
installing/uninstalling EJB applications, or running EJB applications.
•
Do not use this command while an ejbmakeapfolder command is being executed.
•
It is not possible to change the JNDI name of an operating EJB application and then install the
application. Stop the application first and then install it.
ejbinstalleb
When copying the EJB application after deployment to the server machine, if the destination is the
same directory as before, first delete the directory and then copy it.
Message
The following message is output when previously installed EJB applications are included. Enter y to
continue processing, or n to halt processing. Any character string specified after y or n is incorrect but
is disregarded.
EJB application(s) already installed:
[Name of installed EJB application]
EJB application information will be deleted once.
Are you sure to continue EJB application installation? (y/n)
Example
The following shows an example of installing an EJB application when the EJB container is named
"EMPLOYEE" and the file for server is stored in " c:\ejb\213533."
ejbinstalleb -s EMPLOYEE c:\ejb\213533
The following shows an example of installing an EJB application when the EJB container is named
"EMPLOYEE" and the file for server is stored in "/ejb/213533."
ejbinstalleb -s EMPLOYEE /ejb/213533
5-9
Chapter 5: EJB Service Operation Commands
ejbuninstalleb
Name
ejbuninstalleb
Uninstalls EJB applications from their Application Folder.
Synopsis
ejbuninstalleb [-a] [-e] [-s EJB container name] [-y] [-M system name] [EJB
application name]
Description
Uninstalls EJB applications from the Application Folder.
The arguments for this command are as follows:
-a
Uninstalls all EJB applications except the EJB applications installed in the EJB containers. It is not
necessary to specify the EJB application names.
To uninstall the EJB applications in the EJB containers, specify the -s option.
-e
Forcibly uninstalls applications.
Applications can be forcibly uninstalled if a normal uninstall operation fails. However, a forced uninstall
may also fail if the CORBA Service has not been activated or if there are system problems.
-s EJB container name
Specifies the name of the EJB container for which the EJB application to be uninstalled.
If this option is specified with the -a option, all EJB applications in the specified EJB container are
uninstalled.
-y
Uninstalls without outputting a confirmation message.
Uninstalls without outputting a confirmation message for a specified EJB application or for all EJB
applications.
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
EJB application name
Specify the name of the EJB application to be uninstalled.
5-10
ejbuninstalleb
Notes
•
If the EJB application name begins with a hyphen, specify “--” as an argument before the
specification of the EJB application name.
•
Do not use this command while customizing the relevant EJB application definitions, or
installing/uninstalling the relevant EJB application.
•
Do not use this command while the relevant EJB application is running.
•
Do not delete the file in which ejbinstalleb was expanded.
•
Do not use this command while an ejbmakeapfolder command is being executed.
Messages
The following message is output when –a is specified as an argument to uninstall all EJB applications.
Enter y to continue processing, or n to suspend processing. Any character string specified after y or n
will be regarded as an error and ignored.
Are you sure to uninstall all EJB applications? (y/n)
The following message is output when an EJB application name is specified in the argument to be
uninstalled.
Enter y to continue processing, or n to suspend processing. Any character string specified after y or n
will be regarded as an error and ignored.
Are you sure to uninstall specified EJB application? (y/n)
Example
The following shows an example of uninstalling the EJB application named "NameBean" from the EJB
container named "EMPLOYEE."
ejbuninstalleb
-s EMPLOYEE NameBean
5-11
Chapter 5: EJB Service Operation Commands
ejbdstarteb
Name
ejbdstarteb
Starts EJB applications.
Synopsis
ejbdstarteb [-g] [-M system name] [-s EJB container name] [EJB application
name]
Description
Starts EJB applications.
The arguments for this command are as follows:
-g
Specify this argument when debugging EJB applications using the debugger provided by Apworks
V5.0L10 or earlier.
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-s EJB container name
Specifies the EJB container to be started.
EJB application name
Specify the name of the EJB application to be started.
Notes
5-12
•
If the EJB application name begins with a hyphen, specify “--” as an argument before the
specification of the EJB application name.
•
Do not use this command while customizing the relevant EJB application definitions or
installing/uninstalling the relevant EJB applications.
•
Refer to the event log for the results of running this command.
•
If multiple EJB application processes are being run, run this command for each process. The
maximum process multiplicity is 255.
•
The invoking method of an EJB application that can be started is a CORBA-invoked Bean. To start
an RMI-invoked Bean, use Rapid Invocation to start a Rapid Invoking Bean.
ejbdstarteb
•
If –g is specified, the following password character string will appear in the console window. Use
this information to debug EJB applications. Refer to APWORKS Help for details.
Example
Agent password = xxxx
or
Listening for transport dt_socket at address: xxxx
•
Do not use this command while an ejbmakeapfolder command is being executed.
FJEJB_JVM_MX environment variable
FJEJB_JVM_MX is the environment variable specified to start EJB applications when modifying the
amount of Java VM memory used by EJB applications.
Specify from 16 to 2047 MB of integer digits in this environment variable.
The default is the JDK/JRE default value.
An error occurs if a value less than 16 or more than 2048 is specified for this environment variable.
An error occurs if characters other than digits are specified for this environment variable.
If this environment variable is to be used in a JDK/JRE 1.3 or JDK/JRE 1.4environment, first use the
JDK/JRE 1.3 Java command to check whether the value is within the specifiable range. Check in the
following way:
java –Xmx****m –version
(****: Value specified in FJEJB_JVM_MX environment variable)
If version information is displayed when the command is executed, the value can be specified.
The following is an example of setting the FJEJB_JVM_MX environment variable:
SET FJEJB_JVM_MX=16
(1) If Bourne shell is used:
FJEJB_JVM_MX=16
export FJEJB_JVM_MX
(2) If C shell is used:
setenv FJEJB_JVM_MX 16
FJEJB_JVM_OP environment variable
FJEJB_JVM_OP is the environment variable specified to start an EJB application when the Java VM
options used by the EJB application are to be modified.
Specify any character string of up to 256 bytes in this environment variable.
An error occurs if a character string of more than 256 bytes is specified for this environment variable.
Check the JDK version and options before setting this environment variable.
5-13
Chapter 5: EJB Service Operation Commands
Do not specify the following options in this environment variable if performing a debugging start in a JDK
1.3 or JDK1.4 environment:
•
classic
•
hotspot
The following is an example of the FJEJB_JVM_OP environment variable:
SET FJEJB_JVM_OP=-Xms1m
(1) If Bourne shell is used:
FJEJB_JVM_OP=-Xms1m
export FJEJB_JVM_OP
(2) If C shell is used:
setenv FJEJB_JVM_OP –Xms1m
Example
The following shows an example of starting the EJB container named "EMPLOYEE."
ejbstarteb -s EMPLOYEE
5-14
ejbdstopeb
ejbdstopeb
Name
ejbdstopeb
Stops EJB applications.
Synopsis
ejbdstopeb [-g] [-M system name] [-s EJB container name] [EJB application
name]
Description
Stops EJB applications.
The arguments for this command are as follows:
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-s EJB container name
Specifies the EJB container to be stopped.
EJB application name
Specify the name of the EJB application to be stopped.
Notes
•
If the EJB application name begins with a hyphen, specify “--” as an argument before the
specification of the EJB application name.
•
Do not use this command while customizing the relevant EJB application definitions or
installing/uninstalling the relevant EJB applications.
•
If multiple EJB application processes are being run, run this command for each process.
•
Refer to the event log for the results of running this command. Note that the results are not output
to the event log if a stopped or stopping EJB application is stopped.
•
If this command is run for an EJB application that has been started, and no execution results are
output to the event log, the EJB application program may be in a loop.
•
Do not use this command while an ejbmakeapfolder command is being executed.
5-15
Chapter 5: EJB Service Operation Commands
•
There is no problem even if this exception is displayed while the EJB application is stopping.
However, the following exceptions might be printed by the Java debugger in the console window
when the EJB application is stopped if the EJB application is debugged using a debugger provided
by Apworks.
[Java debugger outputs]
Internal debug-agent exception
Example
The following shows an example of stopping the EJB container named "EMPLOYEE."
ejbstopeb -s EMPLOYEE
5-16
ejbinfoapfolder
ejbinfoapfolder
Name
ejbinfoapfolder
Shows Application Folder information.
Synopsis
ejbinfoapfolder [-M system name] [-l] | [EJB application name]
Description
Shows the location of the Application Folder.
The arguments for this command are as follows:
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-l
Displays a list of installed EJB applications
The following information is output:
path
Shows the location of the Application Folder
name
Shows the EJB application name
type
Shows the EJB application mode/type
•
Type
EB: Enterprise Bean
•
Mode
stateless: STATELESS session
stateful: STATEFUL session
BMP-entity: Bean-managed persistence Entity
CMP-entity: Container-managed persistence Entity
Message-Bean: Message-driven Bean
5-17
Chapter 5: EJB Service Operation Commands
ssl
Displays the setup status of encryption communication using SSL.
ON: Encryption communication using SSL is set.
OFF: Encryption communication using SSL is not set.
The message "---" is displayed in the following cases:
•
Rapid invoked Bean
•
Bean that is invoked by RMI
•
EJB application that is created by Interstage V2
EJB application name
Shows detailed information for the specified EJB application.
The following information is output:
path
Shows the location of the Application Folder
name
Shows the EJB application name
type
Shows the EJB application mode/type
•
Type
EB: Enterprise Bean
•
Mode
stateless: STATELESS session
stateful: STATEFUL session
BMP-entity: Bean-managed persistence Entity
CMP-entity: Container-managed persistence Entity
Message-Bean: Message-driven Bean
ImplID
Shows the Implementation Repository ID
Shows “---” for Rapid Invoked and RMI invoked Beans
IntfID
Shows the Interface Repository ID
Shows “---” for Rapid Invoked and RMI invoked Beans
ssl
Displays the setup status of encryption communication using SSL.
ON : Encryption communication using SSL is set.
OFF: Encryption communication using SSL is not set.
The message "---" is displayed in the following cases:
•
5-18
Rapid invoked Bean
ejbinfoapfolder
•
Bean that is invoked by RMI
•
EJB application that is created by Interstage V2
hostname
The hostname is displayed when load balance, which uses TrafficDirector, is used. When load balance
is not used, “---” is displayed.
port
The port number is displayed when load balance, which uses TrafficDirector, is used. When load
balance is not used, “---” is displayed.
containername
Displays the name of the EJB container if the EJB application is installed in the EJB containers.
If the EJB application is not installed in any of the EJB containers, "---" is displayed.
Notes
•
Do not use this command while an ejbmakeapfolder command is being executed.
•
If the EJB application name begins with a hyphen, specify "--" as an argument before the
specification of the EJB application name.
Examples
(1) No argument specified
ejbinfoapfolder
The following is displayed:
path: d:\app
ejbinfoapfolder
The following is displayed:
path: /ejb/ejb001
(2) –l specified
ejbinfoapfolder –l
The following is displayed:
path: d:\app
5-19
Chapter 5: EJB Service Operation Commands
Name
type
ssl
eb001
EB/stateless
ON
eb002
EB/stateful
OFF
entity01
EB/BMP-entity
ON
entity02
EB/CMP-entity
OFF
Total 4 EJB application(s) entered
ejbinfoapfolder –l
The following is displayed:
path: /ejb/ejb001
Name
type
ssl
eb001
EB/stateless
ON
eb002
EB/stateful
OFF
entity01
EB/BMP-entity
ON
entity02
EB/CMP-entity
OFF
Total 4 EJB application(s) entered
Note: In the case of Linux, there is no display of SSL.
(3) ejb-application-name specified
ejbinfoapfolder eb001
The following is displayed:
path: d:\app
Name:
eb001
type:
EB/stateless
ImplID:
IDL:pkgSample/SampleHome:1.0
IntfID:
RMI:pkgSample.SampleHome:0000000000000000
ssl:
ON
hostname:
---
port:
---
containername:
---
ejbinfoapfolder eb001
5-20
ejbinfoapfolder
The following is displayed:
path: /ejb/ejb001
Name:
eb001
type:
EB/stateless
ImplID:
IDL:pkgSample/SampleHome:1.0
IntfID:
RMI:pkgSample.SampleHome:0000000000000000
ssl:
ON
hostname:
---
port:
---
containername:
---
Note: In the case of Linux, there is no display of SSL
5-21
Chapter 5: EJB Service Operation Commands
ejbinfocontainer
Name
ejbinfocontainer
Displays EJB container information.
Synopsis
ejbinforcontainer [-M system name] [-l EJB container name | -s EJB container
name]
Description
This command displays the EJB container information. If no option is specified, the EJB containers that
have been created are listed.
The output contents are described below.
Impl-ID
Displays the implementation repository ID used for the EJB container.
name
Displays the EJB container name.
ssl
Displays the setting status of the encryption communication using SSL.
ON: The encryption communication using SSL is specified.
OFF: The encryption communication using SSL is not specified.
Example of display
Name
ssl
Impl-ID
MyServer
OFF
IDL:MyServer:1.0
Cart
OFF
IDL:Cart:1.0
PetStore
OFF
IDL:PetStore:1.0
Sample
ON
IDL:Sample:1.0
Total 4 EJB container(s)
The arguments of the ejbinfocontainer command are described below.
-M system name
To operate the extended system, specify the system name specified in the iscreatesys command for this
option. If this option is omitted, the default system name is specified.
5-22
ejbinfocontainer
-s EJB container name
Specifies the name of the EJB container of which information is to be displayed. The items defined in
the EJB container definition are output. The EJB container definition file can be created by redirecting
the displayed EJB container definition information to a file.
This option can also be used for updating the EJB container definition.
Example of display
[Common]
name = EMPLOYEE
java = 1.3
thr_conc_init = 50
concurrency = 2
maximum_memory = 128
java_command_option = -DTRACE=ON
classpath = C:\work\xxx.jar
classpath = C:\work\yyy.jar
redirect_mode = true
redirect_path = C:\Temp\ejbcontainer
distributed_tran = false
stateless_rapid_mode = true
cmpupdate_rapid_mode = true
[DataSource]
datasource_name = Datasource1
isolation_level = Transaction-read-committed
previous_connection = 100
[DataSource]
datasource_name = Datasource1
isolation_level = default
previous_connection = 200
-l EJB container name
Displays the list of EJB applications deployed to the EJB containers.
name
Displays the name of the EJB application.
5-23
Chapter 5: EJB Service Operation Commands
type
Displays the type of EJB application. (Not displayed on this version.)
container name : EMPLOYEE
name
type
ShopBean
-
ShoesBean
-
CartBean
-
total 3 EJB application(s)
5-24
ejbcustx
ejbcustx
Name
ejbcustx
Starts the customize tool.
Synopsis
ejbcustx [-s EJB container name] [-a EJB application name] [-ejbdb] [-M
system name]
Description
This command starts the customize tool to customize the EJB application definition information and the
runtime environment information which conform to the EJB1.1 and EJB2.0 specification. When this
command is executed with specifying the EJB container name, the default WorkUnit is also defined.
The arguments for this command are as follows:
-s EJB container name
Specifies the EJB container to which the EJB application to be customized has been deployed.
-a EJB application name
Specifies the EJB application to be customized.
-ejbdb
"DB access environment definition" can be activated from [Tool] on the menu bar.
The Datasource defined by "DB access environment definition" is displayed in addition to the
Datasource defined by the “J2EE resource access definition”. They are displayed in the list of
Datasource names in the window containing the definitions of the Datasource of the Rapid Invocation
definition.
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
Notes
•
This customize tool can be applied to EJB applications which conform to the EJB1.1 and EJB2.0
specification.
•
Do not use this command while the Application Folder is being created.
•
When the relevant EJB application is in use, stop it before running the command. Otherwise you
must restart the IJServer to enable the customized information.
5-25
Chapter 5: EJB Service Operation Commands
•
In the Terminal Service, 256 colors are used for the display screen, and the customize tool screen
may become unstable. However, this does not affect operation.
Example
The following shows an example of customizing the EJB application named "NameBean" in the EJB
container named "EMPLOYEE."
Ejbcustx -s EMPLOYEE -a NameBean
5-26
ejbdefexport
ejbdefexport
Name
ejbdefexport
Exports Enterprise Bean definition information.
Synopsis
ejbdefexport {EJB application name} [-i IJServer name | -s EJB container
name] [-M system name] {[-f Enterprise Bean definition file name] | -all
[directory name]} [-comment {editable | all | non}] [-r] [-encode {UTF-8 |
SJIS | EUC}]
Description
Exports the Enterprise Bean definition information in the IJServer to the Enterprise Bean definition file.
The arguments for this command are as follows:
EJB application name
Specifies the EJB application name which has been installed in the IJServer.
This argument and the -all option cannot be specified at the same time.
-s EJB container name
Specifies the EJB container to which the EJB application has been deployed.
-i IJServer name
Specifies the IJServer to which the EJB application has been deployed.
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-f Enterprise Bean definition file name
Specifies the name of the Enterprise Bean definition file as an absolute path name or a relative path
name. If this specification is omitted, the information is output to the current folder name\EJB
application name.xml.
If an EJB application name contains a slash "/" or colon ":", or begins (??) period "." at the head, it is
converted into an underscore "_" for the output file name. If the EJB application name is
"Session/Sample: Bean", for example, the output file name is "Session_Sample_Bean.xml".
This argument and the -all option cannot be specified at the same time.
5-27
Chapter 5: EJB Service Operation Commands
-all directory name
Outputs all of the Enterprise Bean definition information contained in the IJServer to the specified
directory. If this directory specification is omitted, the information is output to the current directory.
This argument cannot be specified together with the EJB application name and -f option.
The name of the Enterprise Bean definition file to be exported becomes “EJB application name .xml.”
-comment {editable | all | none}
Outputs tag explanations in XML comment format. If this argument is omitted, tag explanations are not
output.
editable : Outputs only the explanations for editable tags.
all : Outputs all tag explanations.
none : Does not output tag explanations.
-r
If an Enterprise Bean definition file with the same name exists, the Enterprise Bean definition file is
overwritten with no conditions. If this argument is omitted, confirmation for overwriting of the file is
carried out.
-encode {UTF-8 | SJIS | EUC}
Specifies the code type of the Enterprise Bean definition file to be output. If this specification is omitted,
UTF-8 is assumed to be specified.
UTF-8 : Outputs the file with UTF-8 ( Unicode).
SJIS : Outputs the file with Shift_JIS.
EUC : Outputs the file with EUC-JP.
Note
If the IJServer to be customized is starting, stop it beforehand.
Examples
ejbdefexport SampleEB -f c:\ejb\SampleDD.xml
ejbdefexport SampleEB -comment editable
ejbdefexport -all c:\ejb
ejbdefexport SampleEB -f /ejb/SampleDD.xml
ejbdefexport SampleEB -comment editable
ejbdefexport -all /ejb
The following shows an example of customizing the EJB application named "NameBean" in the IJServer
named "TestIJServer."
5-28
ejbdefexport
ejbdefexport NameBean -i TestIJServer -f
c:\ejb\NameBean.xml
ejbdefexport NameBean -i TestIJServer -f /ejb/NameBean.xml
5-29
Chapter 5: EJB Service Operation Commands
ejbdefimport
Name
ejbdefimport
Imports Enterprise Bean definition information.
Synopsis
ejbdefimport {[EJB application name] -f Enterprise Bean definition file name
| -all [directory name]} [-i IJServer name | -s EJB container name] [-M
system name]
Description
Imports information of the Enterprise Bean definition file to the Enterprise Bean definition information in
the IJServer.
The arguments for this command are as follows:
EJB application name
Specifies the EJB application name which has been installed in the IJServer. If this specification is
omitted, the EJB application name specified for <component-name> in the Enterprise Bean definition file
is used.
This argument and the -all option cannot be specified at the same time.
-f Enterprise Bean definition file name
Specifies the name of the Enterprise Bean definition file as an absolute path name or a relative path
name.
This argument and the -all option cannot be specified at the same time.
-all directory name
The Enterprise Bean definition file in the specified directory reflects the Enterprise Bean definition
information.
This argument cannot be specified together with the EJB application name and -f options.
The EJB application name of the destination is the one that is specified for <component-name> in the
Enterprise Bean definition file.
-s EJB container name
Specifies the EJB container to which the EJB application has been deployed.
-i IJServer name
Specifies the IJServer to which the EJB application has been deployed.
5-30
ejbdefimport
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
Notes
•
If the EJB application to be customized is starting, stop it beforehand.
•
If DB definition information is specified with the -f option, or if DB definition information exists in a
folder specified with the -all option, the following error is generated in import.
An error occurred when reading the definition file (file name).
There is no root element declaration.
file:///(X):The above error was detected in Line X and Column X.
EJB3504S-20-093-XXXX
Examples
ejbdefimport SampleEB -f c:\ejb\deffile.xml
ejbdefimport -f def.xml
ejbdefimport -all c:\ejb
ejbdefimport SampleEB -f /ejb/deffile.xml
ejbdefimport -f def.xml
ejbdefimport -all /ejb
The following shows an example of importing the Enterprise Bean definition information to the
Enterprise Bean definition file named "c:\ejb\NameBean.xml" in the EJB application named "NameBean"
that has been deployed to the IJServer named "TestIJServer."
ejbdefimport NameBean -i TestIJServer -f c:\ejb\NameBean.xml
The following shows an example of exporting the Enterprise Bean definition information to the
Enterprise Bean definition file named "/ejb/NameBean.xml" in the EJB application named "NameBean"
that has been deployed to the IJServer named "TestIJServer."
ejbdefimport NameBean -i TestIJServer -f /ejb/NameBean.xml
5-31
Chapter 5: EJB Service Operation Commands
ejbdbdefexport
Name
ejbdbdefexport
Exports the DB definition information of the EJB Service.
Synopsis
ejbdbdefexport [-M system name] -f DB definition file name [-comment
{editable | all | none}] [-r] [-encode {UTF-8 | SJIS | EUC}]
Description
Exports the DB definition information of the EJB Service to the DB definition file. This command can be
used to import the information that was set in the DB access environment definition when the ejbcustx
command was executed with the –ejbdb option, to a file.
The arguments for this command are as follows:
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-f DB definition file name
Specifies the name of the DB definition file as an absolute path name or a relative path name.
-comment {editable | all | none}
Outputs tag explanations in XML comment format. If this argument is omitted, tag explanations are not
output.
editable : Outputs only the explanations for editable tags.
all : Outputs all tag explanations.
none : Does not output tag explanations.
-r
If a DB definition file with the same name exists, the DB definition file is overwritten with no conditions.
If this argument is omitted, confirmation for overwriting of the file is carried out.
-encode {UTF-8 | SJIS | EUC}
Specifies the code type of the Enterprise Bean definition file to be output. If this specification is omitted,
UTF-8 is assumed to be specified.
UTF-8 : Outputs the file with UTF-8 ( Unicode).
SJIS : Outputs the file with Shift_JIS.
5-32
ejbdbdefexport
EUC : Outputs the file with EUC-JP.
Notes
•
If the IJServer to be customized is starting, stop it beforehand.
•
This command outputs the Password defined for the DB definition information of the EJB Service
with "*" in the DB definition file.
Example
ejbdbdefexport -f c:\ejb\DBdef.xml -comment editable
ejbdbdefexport -f /ejb/DBdef.xml -comment editable
5-33
Chapter 5: EJB Service Operation Commands
ejbdbdefimport
Name
ejbdbdefimport
Imports DB definition information of the EJB Service.
Synopsis
ejbdbdefimport [-M system name] -f DB definition file name
Description
Imports information of the DB definition file to the DB definition of the EJB Service. This command can
be used to export the information that was set in the DB access environment definition when the
ejbcustx command was executed with the –ejbdb option, to a file.
The arguments for this command are as follows:
-M system name
When using an extended system, specify the same system name as the one specified in the argument
of the iscreatesys command. If this option is omitted, the default system name is used.
-f DB definition file name
Specifies the name of the DB definition file as an absolute path name or a relative path name.
Notes
•
If the IJServer to be customized is starting, stop it beforehand.
•
If the DB definition information is specified with the -f option, or if DB definition information exists in
a folder specified with the -all option, the following error is generated in import.
An error occurred when reading the definition file (file name).
There is no root element declaration.
file:///(X):The above error was detected in Line X and Column X.
EJB3504S-20-093-XXXX
5-34
ejbdbdefimport
Example
ejbdbdefimport -f c:\ejb\db.xml
ejbdbdefimport -f /ejb/db.xml
5-35
Chapter 5: EJB Service Operation Commands
5-36
Chapter 6
JNDI Operation Commands
This chapter details the JNDI operation commands.
6-1
Chapter 6: JNDI Operation Commands
fjj2eeadmin
Name
fjj2eeadmin
Creates resource access definition.
Synopsis
1.
Creating resource access definition
fjj2eeadmin
[-M system]
2.
-jdbc | -javamail
-d resource-name
[-M system]
Displaying resource parameter information
fjj2eeadmin
system]
4.
-s filename | -o filename
Deleting resource parameter information
fjj2eeadmin
3.
-jdbc | -javamail | -connector
-jdbc | -javamail | -connector
-g resource-name
[-M
Displaying a resource list
fjj2eeadmin
-jdbc | -javamail | -connector
-l
[-M system]
Description
This command creates and deletes the resource access definition used for lookup of JDBC or JavaMail,
and displays the resource information.
Moreover, it overwrites the resource access definition used for lookup of connector, and displays the
resource information.
By executing this command for each resource name, resource information for multiple resources can be
registered.
-jdbc | -javamail | connector
Specify the resource access definition applicable to processing. This parameter cannot be omitted when
executing this command.
-jdbc: JDBC resource access definition
-javamail: JavaMail resource access definition
-connector: connector resource access definition
6-2
fjj2eeadmin
-s filename
A resource access definition is created using the specified property file.
This function can be used only if the resource access definition to be processed is JDBC or JavaMail.
filename: Property file (specify with full path)
-o filename
A resource access definition is created using the specified property file. If that resource name
(DATA_SOURCE_NAME, MAIL_SOURCE_NAME, or JCA_SOURCE_NAME) exists at the time of
creation, it is overwritten. If the resource name does not exist, it is created.
If the resource access definition to be processed is JDBC or JavaMail and no resource with the same
name exists, this command creates a new one.
filename: Property file (specify with full path)
-d resource-name
This parameter deletes the parameter information of the specified resource name
(DATA_SOURCE_NAME or MAIL_SOURCE_NAME).
resource-name: Resource name
-g resource-name
This parameter displays the parameter information of the specified resource name
(DATA_SOURCE_NAME, MAIL_SOURCE_NAME, or JCA_SOURCE_NAME).
resource-name: Resource name
-l
This parameter displays a list of the resource names registered in the resource access definition.
-M system
If an extended system is created, specify the system name "system" for operation. If this option is
omitted, the default system is used.
6-3
Chapter 6: JNDI Operation Commands
Resource Access Definition
When the fjj2eeadmin command is successfully executed, the following resource access definition is
created.
For JDBC
C:\Interstage\j2ee\def\jdbc.ser
For JavaMail
C:\Interstage\j2ee\def\mail.ser
For connector
C:\Interstage\j2ee\def\connector.ser
[For JDBC]
/etc/opt/FJSVj2ee/def/jdbc.ser
[For JavaMail]
/etc/opt/FJSVj2ee/def/mail.ser
[For connector]
/etc/opt/FJSVj2ee/def/connector.ser
When generating "jdbc.ser.bak", "mail.ser.bak" and "connector.ser.bak" as temporary work files, if a file
of the same name already exists, it is deleted.
When a system name is specified, a resource access definition is generated according to the following
directory structure:
/var/opt/FJSVisas/system/system name/FJSVj2ee/def
6-4
fjj2eeadmin
Property File
The following table lists the contents of the property file specified by the -s option or -o option.
For JDBC
Table 6-1 Contents of Property File for JDBC
Parameter
Contents
Specification
INITIAL_CONTEXT_
FACTORY
Specifies the class name for the JNDI service provider for
the required JDBC driver to access the Naming Service.
Required
- For Oracle
com.sun.jndi.fscontext.RefFSContextFactory
- For SQL Server
com.fujitsu.interstage.jdbc.FJJdbcContextFactory
PROVIDER_URL
Specifies the URL for the JNDI service provider for the
required JDBC driver to access the Naming Service in the
following format:
Required
- For Oracle
file:///Drive Name:path of the directory containing
PROVIDER URL information
Be sure to specify a drive name.
file:path of the directory containing PROVIDER URL
information.
- For SQL Server
FJIS://localhost [: port number for connecting to the
Naming Service] ([ ] is optional. The optional value of the
port number is 10526.)
DATA_SOURCE_NAME
Specifies the data source name (resource name).
Required
The data source name becomes the name for referencing
data source objects using JNDI.
JDBC_DATA_SOURCE_
NAME (Note 1)
Specifies the data source name registered in the Naming
Service for the required JDBC driver in the following
format:
Required
jdbc/data-source-name
Use the format of the name used which sucessfully
registered into Naming Service of JDBC driver but differed
from the format of "jdbc/data-source-name".
6-5
Chapter 6: JNDI Operation Commands
Parameter
Contents
Specification
USERID (Note 2)
Specifies the user ID for connecting to the database.
Required
PASSWORD (Note 2)
Specifies the password for the user ID for connecting to
the database.
Required
Note 1)
The XA data source cannot be used by the client-side applications.
Note 2)
The user ID and password are used when ‘Container’ is specified in the resource manager connector
(res-auth tag) of the deployment descriptor file specified at the environment setup for the JNDI service
provider, or a Web application environment definition file (at the time of Web application employment).
For Oracle
In Oracle, the following items are also set up.
Table 6-2 Contents of Property File for JDBC
Parameter
Contents
Specification
ORA_DRIVERTYPE
Specifies the driver type to be used from the following:
“thin” or “oci”, for the JNDI service provider of the Oracle
JDBC driver used to access the Naming Service.
The omitted value of the driver type is “thin”. (Note 1).
Required
ORA_NET_PROTOCOL
Specifies the network protocol to be used from the
Required
following: “ipc” or “tcp”, for the JNDI service provider of the
Oracle JDBC driver used to access the Naming Service.
The omitted value of the network protocol is “tcp”. (Note 1).
ORA_DATASOURCE
Specifies the kind of the datasource to be used from the
following:
0 : ”Interstage performs connection pooling”
1 : “Oracle performs connection pooling”
2 : “Use distributed transaction”
The omitted value of the kind of the datasource is “0”.
ORA_URL
Specifies the server URL for the JNDI service provider of
Required
the JDBC driver to be used to access the Naming Service
in the following format:
Jdbc:oracle:{Drivertype}:@{Hostname}:{Portnumber}:{SID}
ORA_MAKE_BINDING
(Note 2)
Specifies “YES” or “NO”, whether make “.bindings” file or
not, to setting access information of Oracle JDBC driver.
The omitted value is “YES”, mean is make “.bindings” file.
Note 1)
If the driver type is “thin”, “tcp” will be specified as the network protocol.
6-6
Required
Required
fjj2eeadmin
Note 2)
To make a “.bindings” file, it is necessary to set the following values to the environment variables.
Table 6-3 Environment Variable for Oracle
Environment variable
Contents (Note 1)
CLASSPATH
Oracle installation directory/jdbc/lib/classes12.zip (Note 2)
Oracle installation directory/jdbc/lib/nls_charset12.zip
Directory in which the downloaded class is stored/providerutil.jar (Note 3)
Directory in which the downloaded class is stored/fscontext.jar (Note 3)
Note 1)
For Windows, please read "/" as "\".
Note 2)
Set up classes12.zip after isj2ee.jar.
Note 3)
When using the class file (providerutil.jar, fscontext.jar) provided with Interstage, it is not necessary to
perform set up. Set up is only required when you use files downloaded from the SUN homepage.
Example of setting using Windows
1.
Select the Control Panel | System | Advanced | Environment Variables tab
The example above shows how this is done in Windows (R) 2000. The procedure may be different
for other operating systems. In addition, when using Windows (R) 9x and Windows (R) Me, you
need to edit the "Autoexec.bat" file.
2.
Add the contents specified in Table 6-3 to the environment variable.
Example of setting using commands
The following is an example showing the settings in when using providerutil.jar and fscontext.jar
downloaded from the SUN homepage.
set
set
set
set
CLASSPATH=%ORACLE_HOME%\jdbc\lib\classes12.zip;%CLASSPATH%
CLASSPATH=%ORACLE_HOME%\jdbc\lib\nls_charset12.zip;%CLASSPATH%
CLASSPATH=C:\classes\providerutil.jar;%CLASSPATH%
CLASSPATH=C:\classes\fscontext.jar;%CLASSPATH%
When using the C shell:
setenv
setenv
setenv
setenv
CLASSPATH
CLASSPATH
CLASSPATH
CLASSPATH
${ORACLE_HOME}/jdbc/lib/classes12.zip:${CLASSPATH}
${ORACLE_HOME}/jdbc/lib/nls_charset12.zip:${CLASSPATH}
/classes/fscontext.jar:${CLASSPATH}
/classes/providerutil.jar:${CLASSPATH}
6-7
Chapter 6: JNDI Operation Commands
When setting the file of “isj2ee.properties”
The following is an example showing the settings in when using providerutil.jar and fscontext.jar
downloaded from the SUN homepage.
classpath=Oracle installation directory\jdbc\lib\classes12.zip;Oracle
installation directory\jdbc\lib\nls_charset12.zip;Directory in which the
downloaded class is stored\providerutil.jar;Directory in which the
downloaded class is stored\fscontext.jar
When using the C shell:
classpath=Oracle installation directory/jdbc/lib/classes12.zip:Oracle
installation directory/jdbc/lib/nls_charset12.zip:Directory in which the
downloaded class is stored/providerutil.jar:Directory in which the
downloaded class is stored/fscontext.jar
Sample coding
<For Oracle>
INITIAL_CONTEXT_FACTORY= com.sun.jndi.fscontext.RefFSContextFactory
PROVIDER_URL=file:/tmp/JNDI
DATA_SOURCE_NAME=DS1
JDBC_DATA_SOURCE_NAME=jdbc/DS1
USERID=user1
PASSWORD=pass1
ORA_DRIVERTYPE=thin
ORA_NET_PROTOCOL=tcp
ORA_DATASOURCE=2
ORA_URL=jdbc:oracle:thin:@romeo:1521:sid
ORA_MAKE_BINDING=YES
<For SQL Server>
INITIAL_CONTEXT_FACTORY= com.fujitsu.interstage.jdbc.FJJdbcContextFactory
PROVIDER_URL=FJIS://localhost
DATA_SOURCE_NAME=DS1
JDBC_DATA_SOURCE_NAME=jdbc/DS1
USERID=user1
PASSWORD=pass1
6-8
fjj2eeadmin
For JavaMail
Table 6-4 Contents of Property File for JavaMail
Parameter
Contents
Specification
MAIL_SOURCE_NAME
Specify the resource name.
Required
The resource source name becomes the name for
referencing JavaMail objects using JNDI.
mail.from
Specify a mail sender.
Required
mail.user
Specify the login user name of the mail server.
Required
mail.host
Specify the IP address or the host name of the mail
server.
Required
mail.smtp.host (Note)
Specify the IP address or the host name of the SMTP
server.
Arbitrary
mail.smtp.port (Note)
Specify the port number of the SMTP server.
Arbitrary
mail.smtp.user (Note)
Specify the user name for SMTP Authentication.
Arbitrary
mail.imap.host (Note)
Specify the IP address or the host name of the IMAP
server.
Arbitrary
mail.imap.port (Note)
Specify the port number of the IMAP server.
Arbitrary
mail.imap.user (Note)
Specify the login user name for the IMAP server.
Arbitrary
mail.pop3.host (Note)
Specify the IP address or the host name of the POP3
server.
Arbitrary
mail.pop3.port (Note)
Specify the port number of the POP3 server.
Arbitrary
mail.pop3.user (Note)
Specify the login user name for the POP3 server.
Arbitrary
Note)
This parameter is specified when using a different value from mail.user or mail.host, or when using a
port other than the default port. The default port number is:
- SMTP server : 25
- IMAP server : 143
- POP3 server : 110.
Sample coding
MAIL_SOURCE_NAME=MailSession
mail.from=JavaMailTester
mail.user=tester
mail.host=10.0.0.1
6-9
Chapter 6: JNDI Operation Commands
For connector
Table 6-5 Contents of Property File for Connector
Parameter
Contents
Specification
JCA_SOURCE_NAME
Specify the connection factory name (resource name) for Required.
deployment.
Not changeable
(Note 1)
The connection factory name becomes the name for
referencing connection factory objects using JNDI.
RAR_NAME
Specify the resource adapter file name (RAR file name)
to be associated with the resource name.
Required.
Not changeable
(Note 1)
USER_NAME
Specify the user name for connecting to the resource
adapter.
Arbitrary
PASSWORD
(Note 2)
Specify the password for connecting to the resource
adapter.
Arbitrary
CONFIG_PROPERTY
(Note 3)
Specify the config-property information (property name,
class name of the property value, and property value)
defined in the deployment descriptor of the resource
adapter specified for deployment. Use the following
format when defining the config property value:
Arbitrary
(Note 4)
CONFIG_PROPERTY1=property name <tab> class
name of the property name <tab> property value
Note 1)
For this parameter, specify the value that is referenced by using the display function (fjj2eeadmin connector -g resource-name) for parameter information.
Note 2)
When specifying the PASSWORD parameter, the USER_NAME parameter must also be specified.
Note 3)
The CONFIG_PROPERTY parameter can be specified multiple times. If the parameter is specified
multiple times, specify a parameter name that begins with "CONFIG_PROPERTY" and does not already
exist. However, the number of CONFIG_PROPERTY parameters must remain the same as for
deployment.
6-10
fjj2eeadmin
Note 4)
The CONFIG_PROPERTY parameter value must be specified as a set of the property name, class
name of the property value, and property value, each separated by a <tab>. However, only the property
value can be changed. The property name and the class name of the property value to be specified
must be the same as those referenced by using the display function of parameter information.
Sample coding
JCA_SOURCE_NAME=RA001
RAR_NAME=ra001.rar
USER_NAME=raUser1
PASSWORD=raPass1
CONFIG_PROPERTY1=str
CONFIG_PROPERTY2=flag
CONFIG_PROPERTY3=number
java.lang.String
java.lang.Boolean
java.lang.Integer
test
true
123
Notes
•
When executing the fjj2eeadmin command, the environment variables must be set as follows:
- environment variable CLASSPATH
- C:\Interstage\j2ee\lib\isj2ee.jar
- environment variable PATH
- C:\Interstage\j2ee\bin
- environment variable CLASSPATH
- /opt/FJSVj2ee/lib/isj2ee.jar
- environment variable PATH
- /opt/FJSVj2ee/bin
•
If a resource (DATA_SOURCE_NAME or MAIL_SOURCE_NAME) of the same name is already
registered at the time of -s option specification, an error occurs.
•
If the -o option is specified, the resource access definition to be processed is connector, and no
resource with the same name (JCA_SOURCE_NAME) is registered, an error occurs.
•
Execute this command with Administrator authority.
Messages
For information on error messages displayed during the execution of commands, refer to information on
messages output during resource access definition in the Messages Manual.
6-11
Chapter 6: JNDI Operation Commands
j2eejndisetup
Name
j2eejndisetup
Start J2EE resource access definition.
Synopsis
j2eejndisetup
[-M system]
Description
This command starts the J2EE resource access definition that creates and edits the resource access
definition used for lookup of JDBC, JavaMail, JMS, or connector on a GUI screen.
-M system
If an extended system is created, specify the system name "system" as the target of operation. If this
option is omitted, the target of operation is the default system.
Notes
•
When executing the j2eejndisetup command, the environment variables must be set as follows:
- environment variable CLASSPATH
- C:\Interstage\j2ee\lib\isj2ee.jar
- environment variable PATH
- C:\Interstage\j2ee\bin
- environment variable CLASSPATH
- /opt/FJSVj2ee/lib/isj2ee.jar
- environment variable PATH
- /opt/FJSVj2ee/bin
•
Execute this command with Administrator authority.
Messages
For information on error messages displayed during the execution of commands, refer to information on
messages output during resource access definition in the Messages Manual.
6-12
Chapter 7
JMS Operation Commands
This chapter details the JMS operation commands.
Note
The JMS operation command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
7-1
Chapter 7: JMS Operation Commands
Commands Overview
The overview shows a list of the JMS commands, and then describes the specification format of the
command names and their arguments at start time. Table 7-1 lists the commands provided by JMS.
Table 7-1 List of JMS Commands
Classification
Command name Overview
ConnectionFactory
jmsmkfact
Registers ConnectionFactory definition.
jmsrmfact
Deletes ConnectionFactory definition.
jmsinfofact
Displays ConnectionFactory definition list.
jmsmkdst
Registers Destination definition.
jmsrmdst
Deletes Destination definition.
jmsinfodst
Displays Destination definition list.
jmsrmds
Deletes durable Subscriber.
jmsinfods
Displays durable Subscriber list.
Cluster service function
jmssetupcluster
Creates, displays, and deletes cluster environment.
Backup and restore
jmsbackup
Backs up Interstage JMS resources
jmsrestore
Restores Interstage JMS resources
jmschmod
Changes to the specific user authorization mode.
Destination
Durable Subscriber
Enhancement of security
7-2
jmsmkfact
jmsmkfact
Name
jmsmkfact
Registers ConnectionFactory definition.
Synopsis
jmsmkfact [-t|-q] -i <client-id> [-x] <jndi-name> [-M system]
jmsmkfact -o [-t|-q] [-i <client-id>] [-x] <jndi-name> [-M system]
Description
Registers JMS ConnectionFactory definition. The available options and parameters are shown below:
-o
Overwrites the ConnectionFactory definition with the same name at registration. If ConnectionFactory
definition with the same name does not exist, registers it as a new definition.
When this option is omitted, the ConnectionFactory definition is registered if ConnectionFactory
definition with the same name does not exist.
-t
Specify this option when the ConnectionFactory type is TopicConnectionFactory.
When the -o option is specified, and this option is omitted, already-registered information is used.
-q
Specify this option when the ConnectionFactory type is QueueConnectionFactory.
When the -o option is specified, and this option is omitted, already-registered information is used.
-i <client-id>
Specify the client identifier to be set in the ConnectionFactory definition. The JMS provider uses this
information to identify durable Subscriber.
When the -o option is specified if this option is omitted, already-registered information is used.
-x
Specify this option to use the global transaction function.
If this option is specified with the -t option, ConnectionFactory becomes TopicConnectionFactory which
supports the global transaction function.
If this option is specified together with the -q option, ConnectionFactory becomes
QueueConnectionFactory which supports the global transaction function.
When the -o option is specified, and this option is omitted together with the -t and -q options, alreadyregistered information is used.
7-3
Chapter 7: JMS Operation Commands
<jndi-name>
Specify the JNDI name to be set in the ConnectionFactory definition. The JMS application can obtain
the ConnectionFactory definition by using the specified JNDI name.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When registering a new definition, if both the -t option and the -q option are omitted, the same
operation is performed as when the -t option is specified.
•
When the -o option is specified to overwrite the definition that has been registered, specify any of
the following options: -t, -q, or -x.
•
When the extended system name is specified with the -M option, the -x option cannot be specified.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed. This command may not be executed if a JMS application is being executed.
•
If an active JMS application already exists when this command is used, the updated definition
information is effective at the next time the JMS application is started.
•
The following restrictions are imposed on the JNDI name and client identifier.
•
−
Alphabets (both upper- and lower-case letters), digits, period (.), colon (:), underscore (_),
hyphen (-), and slash (/) are available. A slash is treated as a delimiter for atomic names of a
JNDI name.
−
The atomic name and client identifier must begin with an alphabet followed by a digit.
−
In the case of JNDI name, “java:comp/env/jms/” is automatically added at the top of a specified
JNDI name. To reference a JNDI name from a JMS application, the JNDI name must be
preceded by "java:comp/env/jms/".
−
A string can consist of up to 255 bytes. Note that the JNDI name excluding
"java:comp/env/jms/" must be 255 bytes or less.
If the Interstage management console is used to list ConnectionFactories while a JNDI name
including the character shown below is specified, processing fails and error message "jms9997" is
output. When the Interstage management console is used, do not include the following character
in the JNDI name and client identifier.
−
•
7-4
Colon (:)
The ConnectionFactory definition of JNDI name "TopicCF001" is registered as the default definition
of the TopicConnectionFactory type. The ConnectionFactory definition of JNDI name
"QueueCF001" is registered as the default definition of the QueueConnectionFactory type. The
default definitions can be changed by specifying the -o option.
jmsmkfact
Examples
To newly register a TopicConnectionFactory-type ConnectionFactory definition whose client identifier is
"client1" and JNDI name is "java:comp/env/jms/TestTopicFactory":
jmsmkfact -t -i client1 TestTopicFactory
To newly register a QueueConnectionFactory-type ConnectionFactory definition whose client identifier is
"client1" and JNDI name is "java:comp/env/jms/TestQueueFactory":
jmsmkfact -q -i client1 TestQueueFactory
To change the client identifier of ConnectionFactory definition whose JNDI name is
"java:comp/env/jms/TestTopicFactory" to "client2":
jmsmkfact -o -i client2 TestTopicFactory
7-5
Chapter 7: JMS Operation Commands
jmsrmfact
Name
jmsrmfact
Deletes ConnectionFactory definition
Synopsis
jmsrmfact <jndi-name> [-M system]
Description
This command deletes JMS ConnectionFactory definition.
The option and parameter of the jmsrmfact command are explained below.
<jndi-name>
Specify the JNDI name set in the ConnectionFactory definition to be deleted.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed. This command may not be executed if a JMS application is being executed.
•
If an active JMS application already exists when this command is used, the updated definition
information is effective at the next time the JMS application is started.
•
The ConnectionFactory definition of JNDI name "TopicCF001" is registered as the default definition
of the TopicConnectionFactory type. The ConnectionFactory definition of JNDI name
"QueueCF001" is registered as the default definition of the QueueConnectionFactory type. It is not
allowed to delete the default definition.
Example
To delete ConnectionFactory definition whose JNDI name is "java:comp/env/jms/TestFactory":
jmsrmfact TestFactory
7-6
jmsinfofact
jmsinfofact
Name
jmsinfofact
Display ConnectionFactory definition list.
Synopsis
jmsinfofact [-t | -q] [-M system]
Description
This command displays the JMS ConnectionFactory definition list.
The list displays the total number of displayed ConnectionFactory definitions, then provides the
information categorized by ConnectionFactory type. The items in each ConnectionFactory definition are
displayed in the following order.
•
Serial number
•
ConnectionFactory JNDI name
•
Client identifier
•
Global transaction function settings
The available options and parameters are listed below:
-t
Lists the ConnectionFactory definitions of TopicConnectionFactory.
-q
Lists the ConnectionFactory definitions of QueueConnectionFactory.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When both the -t option and -q option are omitted, all ConnectionFactory definitions are listed.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed.
7-7
Chapter 7: JMS Operation Commands
Example
jmsinfofact
[Total count : 2]
+--[TopicConnectionFactory count : 1]
|
+--[1]
|
[JNDI Name]
: TestTopicFactory
|
[Client ID]
: client1
|
[Global Transaction] : false
|
+--[QueueConnectionFactory count : 1]
+--[1]
[JNDI Name]
: TestQueueFactory
[Client ID]
: client1
[Global Transaction] : false
7-8
jmsmkdst
jmsmkdst
Name
jmsmkdst
Registers Destination definition.
Synopsis
jmsmkdst [-t | -q] -g <group-name> -c <channel-name> <jndi-name> [-M system]
jmsmkdst -o [-t | -q] [-g <group-name>] [-c <channel-name>] <jndi-name> [-M
system]
Description
This command registers JMS Destination definition. The options and parameters of this command are
shown below.
-o
Overwrites the Destination definition with the same name at registration. If Destination definition with
the same name does not exist, registers it as a new definition.
When this option is omitted, the Destination definition is registered if Destination definition with the same
name does not exists.
-t
Specified when the Destination definition type is Topic.
If this option is omitted when the -o option is specified, the information that has already been registered
is used.
-q
Specified when the Destination definition type is Queue.
If this option is omitted when the -o option is specified, the information that has already been registered
is used.
-g <group-name>
Specify the group name of the event channel to be linked.
When the -o option is specified if this option is omitted, already-registered information is used.
-c <channel-name>
Specify the channel name of the event channel to be linked.
When the -o option is specified if this option is omitted, already-registered information is used.
7-9
Chapter 7: JMS Operation Commands
<jndi-name>
Specify the JNDI name to be set in Destination definition. The JMS application can obtain Destination
definition using the specified JNDI name.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When registering a new definition, if both the -t option and the -q option are omitted, the same
operation is performed as when the -t option is specified.
•
When the -o option is specified to overwrite the definition that has been registered, specify any of
the following options: -t, -q, -g, or -c.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed. This command may not be executed if a JMS application is being executed.
•
If an active JMS application already exists when this command is used, the updated definition
information is effective at the next time the JMS application is started.
•
The following restrictions are imposed on the JNDI name, group name and channel name:
•
−
Alphabets (both upper- and lower-case letters), digits, period (.), colon (:), underscore (_),
hyphen (-), and slash (/) are available. A slash is treated as a delimiter for atomic names of a
JNDI name.
−
The atomic name and client identifier must begin with an alphabet followed by a digit.
−
A specified JNDI name is automatically preceded by "java:comp/env/jms/". To reference a
JNDI name from a JMS application, the JNDI name must be preceded by "java:comp/env/jms/".
−
A string can consist of up to 255 bytes. Note that the JNDI name excluding
"java:comp/env/jms/" must be 255 bytes or less.
If the Interstage management console is used to list ConnectionFactories while a JNDI name
including the character shown below is specified, processing fails and error message "jms9997" is
output. When the Interstage management console is used, do not include the following character
in the JNDI name, group name, and channel name.
−
7-10
Colon (:)
jmsmkdst
Examples
To link an event channel whose group name is "jms_topic" and whose channel name is "topic1" to a
new Topic-type Destination definition called "java:comp/env/jms/TestTopic":
jmsmkdst -t -g jms_topic -c topic1 TestTopic
To link an event channel whose group name is "jms_queue" and whose channel name is "queue1" to a
new Queue-type Destination definition called "java:comp/env/jms/TestQueue":
jmsmkdst -q -g jms_queue -c queue1 TestQueue
To change the channel name of the event channel of Destination definition whose JNDI name is
"java:comp/env/jms/TestTopic" to channel name "topic2":
jmsmkdst -o -c topic2 TestTopic
7-11
Chapter 7: JMS Operation Commands
jmsrmdst
Name
jmsrmdst
Deletes Destination definition.
Synopsis
jmsrmdst <jndi-name> [-M system]
Description
This command deletes JMS Destination definition.
The parameter of this command is shown below.
<jndi-name>
Specifies the JNDI name set in Destination definition to be deleted.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed. This command may not be executed if a JMS application is being executed.
•
If an active JMS application already exists when this command is used, the updated definition
information is effective at the next time the JMS application is started.
Example
To delete Destination definition whose JNDI name is "java:comp/env/jms/TestTopic":
jmsrmdst TestTopic
7-12
jmsinfodst
jmsinfodst
Name
jmsinfodst
Displays Destination definition list.
Synopsis
jmsinfodst [-t | -q] [-M system]
Description
This command displays the Destination definition list.
The list displays the total number of displayed Destination definitions followed by information
categorized by Destination type. The items in each Destination definition are displayed in the following
order:
•
Serial number
•
Destination definition JNDI name
•
Related event channel group name
•
Event channel
The available options and parameters are listed below:
-t
Lists the Topic-type Destination definitions.
-q
Lists the Queue-type Destination definitions.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
When both the -t option and the -q option are omitted, all Destination definitions are listed.
•
When the jmsmkfact, jmsmkdst, jmsrmfact, or jmsrmdst command is active, this command cannot
be executed.
7-13
Chapter 7: JMS Operation Commands
Example
jmsinfodst
[Total count : 2]
+--[Topic count : 1]
|
+--[1]
|
[JNDI Name]
|
[Group Name]
|
[Channel Name]
|
+--[Queue count : 1]
+--[1]
[JNDI Name]
[Group Name]
[Channel Name]
7-14
: TestTopic
: jms_topic
: topic1
: TestQueue
: jms_queue
: queue1
jmsrmds
jmsrmds
Name
jmsrmds
Deletes durable Subscriber.
Synopsis
jmsrmds -n <dsub-name> -i <client-id> [-M system]
Description
This command deletes durable Subscriber which is already created. The options and parameters of this
command are shown below.
-n <dsub-name>
Specify the name of durable Subscriber to be deleted. The name of durable Subscriber is called
durable subscription name.
-i <client-id>
Specify the client identifier used for creating durable Subscriber to be deleted.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
An event channel must be active before executing this command.
•
Confirm that durable Subscriber to be deleted is in stop state before executing this command.
Example
To delete durable Subscriber whose durable subscription name is "dsub" and client identifier is "client1":
jmsrmds -n dsub -i client1
7-15
Chapter 7: JMS Operation Commands
jmsinfods
Name
jmsinfods
Displays durable Subscriber list.
Synopsis
jmsinfods [-M system]
Description
This command displays durable Subscriber list. The durable Subscriber name, client identifier, and
topic name (JNDI name of Destination definition) are displayed from the left.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Note
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
Example
jmsinfods
DS name
------dsub
7-16
ClientID
-------client1
Topic Name
---------TestTopic
jmssetupcluster
jmssetupcluster
Name
jmssetupcluster
Creates, displays, or deletes the cluster environment.
Synopsis
jmssetupcluster <cluster-path> [-w|-r] [-M system]
jmssetupcluster –l [-M system]
jmssetupcluster –d [-M system]
Description
This command has the following functions:
1.
Creates a cluster environment.
2.
Displays a cluster environment.
3.
Deletes a cluster environment.
The options and parameters of this command are shown below.
<cluster-path>
Specify the path of the shared disk in which JMS non-volatile information (durable Subscriber
information) is stored in cluster service function operation.
-w
When this option is omitted, the cluster environment for the production server is created.
When this option is specified, the cluster environment for the standby server is created.
-r
Specify this option to repair the cluster environment.
-l
Specify this option to display the cluster environment that is set.
-d
Specify this option to delete the cluster environment that is set.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
7-17
Chapter 7: JMS Operation Commands
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
The following restrictions are imposed on path specification of the shared disk:
−
The path must be a full path.
−
The path can be a string consisting of up to 127 bytes.
•
The path of the shared disk that is specified at creation of the cluster environment should not
specify the directory in which other resources are stored.
•
Specify the -r option to repair the cluster environment definition file when a message whose
message number is jms6200 or jms6201 is displayed.
•
Confirm that the JMS application is in stop state before executing this command.
Examples
To create the cluster environment for the production server using the shared disk "D:\cluster\jms":
jmssetupcluster D:\cluster\jms
To create the cluster environment for the standby server using the shared disk "D:\cluster\jms":
jmssetupcluster D:\cluster\jms –w
To create the cluster environment for the production server using the shared disk "/cluster/jms":
jmssetupcluster /cluster/jms
To create the cluster environment for the standby server using the shared disk "/cluster/jms":
jmssetupcluster /cluster/jms –w
7-18
jmschmod
jmschmod
Name
jmschmod
Changes to the specific user authorization mode.
Synopsis
jmschmod owner [-M system]
Description
Changes the operation of Interstage JMS to the specific user authorization mode to enhance the level of
security.
The options and parameters of this command are shown below.
owner
Specify the specific user ID for the Interstage JMS operation.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority.
•
Execute this command while Interstage is stopped.
Examples
If the mode is changed to the authorization mode of the user ID "root"
/opt/FJSVjms/bin/jmschmod root
7-19
Chapter 7: JMS Operation Commands
7-20
Part 3
SOAP Edition
Chapter 8
SOAP Service Operation Commands
This chapter describes the operating commands provided by the Interstage SOAP Service.
/opt/FJSVsoap/bin
Notes
The SOAP Service Operation Commands can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
The soapsetcldeploy command can be used in Windows(R) System
8-1
Chapter 8: SOAP Service Operation Commands
soapmodifydd
Name
soapmodifydd
Operation of Web Service information
Synopsis
(1) To register Web Service information
soapmodifydd -deploy -url URL -urn URN [-sv|-cl] [-verify|-noverify]
[-sign|-nosign] [-encrypt|-noencrypt] [-decrypt|-nodecrypt]
[-ns Naming] [-edel|-endel] XML_file
(2) To delete Web Service information
soapmodifydd -undeploy -url URL -urn URN [-sv|-cl]
(3) To replace Web Service information with that specified by XML_file
soapmodifydd -replace -url URL -urn URN [-sv|-cl] [-verify|-noverify]
[-sign|-nosign] [-encrypt|-noencrypt] [-decrypt|-nodecrypt]
[ -ns Naming ] [-edel|-endel ] XML_file
(4) To list the Web Service identifier registered with the Web Service Manager
soapmodifydd -list -url URL [-sv|-cl]
(5) To display Web Service information of the Web Service identifier by the -urn option
soapmodifydd -query -url URL -urn URN [-sv|-cl]
(6) To register Web Service information in batch
soapmodifydd -set [-sv|-cl] -url URL XML_file
(7) To delete Web Service information in batch
soapmodifydd -set [-sv|-cl] -url URL XML_file
8-2
soapmodifydd
(8) To register Reliable Information
soapmodifydd -deploy -url URL -urn URN {-push | -pull } msgid
[-partyid partyid1,partyid2,...]
(9) Generating and registering Web service information
soapmodifydd -make -url URL [ -urn URN ] -webapp WebApp_className
[ -file Base_fileName1,Base_fileName2,...] [ XML_file ]
(1) To register Web Service information
soapmodifydd -deploy [ -M systemname ] -url URL -urn URN [-sv|-cl]
[-verify|-noverify] [-sign|-nosign] [-encrypt|-noencrypt]
[-decrypt|-nodecrypt] [ -ns Naming ] [-edel|-endel ] XML_file
(2) To delete Web Service information
soapmodifydd -undeploy [ -M systemname ] -url URL -urn URN [-sv|-cl]
(3) To replace Web Service information with that specified by XML_file
soapmodifydd -replace [ -M systemname ] -url URL -urn URN [-sv|-cl]
[-verify|-noverify] [-sign|-nosign] [-encrypt|-noencrypt]
[-decrypt|-nodecrypt] [-ns Naming ] [-edel|-endel] XML_file
(4) To list Web Service identifiers registered with Web Service Information Management
soapmodifydd -list [ -M systemname ] -url URL [-sv|-cl]
(5) To display Web Service information of the Web Service identifier by the -urn option
soapmodifydd -query [ -M systemname ] -url URL -urn URN [-sv|-cl]
(6) To register Web Service information in batch
soapmodifydd -set [ -M systemname ] [-sv|-cl] -url URL XML_file
(7) To delete Web Service information in batch
soapmodifydd -set [ -M systemname ] [-sv|-cl] -url URL XML_file
(8) To register Reliable Information
soapmodifydd -deploy [ -M systemname ] -url URL -urn URN {-push | -pull }
msgid [-partyid partyid1,partyid2,...]
(9) Generating and registering Web service information
8-3
Chapter 8: SOAP Service Operation Commands
soapmodifydd –make [ -M systemname ] -url URL [ -urn URN ]
-webapp WebApp_className
[ -file Base_fileName1,Base_fileName2,...] [ XML_file ]
Description
This command makes a request to the Web Service Manager to operate the Web Service information.
-deploy
Registers Web Service information.
-undeploy
Deletes Web Service information.
-replace
Replaces Web Service information specified by XML_file.
-list
Lists Web Service identifiers.
-query
Displays Web Service information of the Web Service identifier specified by the -urn option.
-set
Registers or deletes Web Service information in batch.
Whether the information is registered or deleted is determined by information in the specified XML_file.
•
When the deployment tag and Web Service identifier are specified, Web Service information on the
specified Web Service identifier is added and updated in batch.
•
When the undeployment tag and the Web Service identifier are specified, Web Service information
on the specified Web Service identifier is deleted in batch
-make
Analyzes the Java class of the Web service application (Web service) specified by WebApp_className
of the -webapp option and registers Web service information.
Defaults are used for the following items in the Web service information registry:
Item name
Description
Web service identifier
“urn:”+ WebApp_className
(-urn: When the URN option is specified, the userspecified URN is used.)
Life cycle of Web service application
“application”
User definition information
“urn:Fujitsu-Soap-Service-Data”
- namespace name
User definition information
- XML data type name
8-4
Character string of user definition type class name after
converting "." into "-"XML data type name
soapmodifydd
Item name
Description
Parameter attribute
"in" or "inout" ("out" is not registered.)
Parameter name
Serial number from "arg1"
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-url URL
Specify the URL of the Web Service Container. The following is the coding format:
http://host name [: port number]/web application identifier/servlet/servlet name
The port number can be omitted. If the port number is omitted, the HTTP standard No. 80 is used.
When "- cl" is specified for a registration destination of Web Service information, this option is ignored.
-urn URN
Specify a Web Service identifier to be registered or already registered with the Web Service Information
Management.
Only characters that can be used in the XML namespace can be used.
URN (the Web Service identifier) must be the same as the object name of the Naming Service when
cooperating with CORBA applications and component transaction applications.
Specify the Enterprise Bean name for URN (Web Service identification name) when cooperating with
EJB applications.
-sv | -cl
Specify the registration destination of the Web Service information. The specifiable options are as
follows:
"-sv": Processes the Web Service information as Web Service information on the server application.
"-cl": Processes the Web Service information as Web Service information on the client application.
When this option is omitted, it is assumed that - sv was specified.
-auth
Specify -auth if basic authentication is performed for the Servlet gateway of the Web server on which
the Interstage SOAP Service is active. If this option is specified, a prompt is displayed to ask for the
user name and password of the basic authentication for the Servlet gateway.
If the basic authentication fails, re-execute the command.
-ns Naming
Specify the name used by the reaching component transaction coordinated function of CORBA for the
Naming Service.
If this option is omitted, it becomes a name for service of the naming of the parameter of the -urn option.
Specify Naming according to the CORBA Service naming rules for the Naming Service (For instance,
specify the escape character (\) ahead of "/" other than for a naming context).
8-5
Chapter 8: SOAP Service Operation Commands
Example :
-ns http:\/\/NS1/NS2
Specify Naming within 255 characters.
-verify | -noverify
Specify whether or not signature verification is to be performed for SOAP messages.
“-verify” : Signature verification is to be performed for SOAP messages.
“-noverify” : Signature verification is not to be performed for SOAP messages.
Specification of this option is given greater priority than Web Service information in XML_file.
-sign | -nosign
Specify whether or not signature addition is to be performed for SOAP messages.
“-sign” : Signature addition is to be performed for SOAP messages.
“-nosign” : Signature addition is not to be performed for SOAP messages.
Specification of this option is given greater priority than Web Service information in XML_file.
-encrypt | -noencrypt
Specify whether or not SOAP messages are encrypted.
“-encrypt” : SOAP messages are encrypted.
“-noencrypt” : SOAP messages are not encrypted.
Specification of this option is given greater priority than Web Service information in XML_file.
-decrypt | -nodecrypt
Specify whether or not SOAP messages are decrypted.
“-decrypt” : SOAP messages are decrypted.
“-nodecrypt” : SOAP messages are not decrypted.
Specification of this option is given greater priority than Web Service information in XML_file.
-edel | -endel
Specify whether or not to delete HeaderElement that has been processed to the SOAP message.
“-edel” : HeaderElement which has been processed to the SOAP message is deleted.
“-endel” : HeaderElement which has been processed to the SOAP message is not deleted.
Specification of this option is given greater priority than Web Service information in XML_file.
{-push | -pull} msgid
Specify the model for reliable transmission of the SOAP message.
“-push” : Model in which the server system receives the message
“-pull” : Model in which the client system receives the message
The same name as the message type specified in "-messageid" in the soapsecrelconf command must
be specified for msgid.
8-6
soapmodifydd
-partyid partyid1,partyid2,...
Specify the identifier to specify the other party of the communication who used the reliable messaging
function.
If two or more other parties of a communication are specified, specify them delimiting partyid with a
comma.
When the reliable transmission of the SOAP message is "- push", the sender ID is specified.
When the reliable transmission of the SOAP message is "- pull", the receiver ID is specified.
It is necessary to specify the same name for partyid as "-partnerid" in the soapsecrelconf command.
-webapp WebApp_className
Specifies the class name with a package name of the Java class of the Web service application (Web
service) for which Web service information is to be registered.
-file Base_fileName1,Base_fileName2,...
Specifies the class file name or JAR file name of the Web service for which Web service information is
to be registered. If two or more files are to be specified, delimit them with a comma (,).
If this option is specified, a class name must be specified with the -webapp option.
If this option is omitted, the Java class specified with the -webapp option is retrieved from environment
variable CLASSPATH.
XML_file
Specify the name of the file that describes the Web Service.
If the file name or path name contains any blank character, enclose the whole file name in double
quotation mark (").
If the -make option is specified, Web service information is output to XML_file.
Messages
Execution results of this command are output on the screen where the command was executed.
Notes
•
This command can be used for the Web service manager in the local host.
•
If the Web server on which the Interstage SOAP Service is active is running in an SSL
communication environment, an SSL environment of the client application must be constructed on
the host on which this command is executed. For details, refer to the Security System Guide.
•
If the -make option is specified, a CORBA application, component transaction (TD) application, or
EJB application cannot be specified for WebAPP_className of the -webapp option.
•
Only users belonging to the Administrators local group can execute this command.
8-7
Chapter 8: SOAP Service Operation Commands
•
Only the superuser is authorized to execute this command.
Examples
Example of contents of registration (list display)
soapmodifydd -list -url
http://localhost:12000/soap_admin/servlet/WSContainer
urn:testservice
urn:service5
Example of automatic registration
Automatic registration of sample Calc
soapmodifydd -make -url
http://localhost:12000/soap_admin/servlet/WSContainer -webapp
Calc.server.CalcServer -file CalcServer.class,CalcServerIf.class
Example of contents of registration (detailed display)
Registration of Calc of a sample is checked.
soapmodifydd –query -url
http://localhost:12000/soap_admin/servlet/WSContainer -urn urn:sample-calc
<deployment xmlns="urn:xmlns-fujitsu-com:soapx-wsdd-2002-10"
xmlns:java="urn:xmlns-fujitsu-com:soapx-wsdd-providers-java-2002-10">
<service name="urn:sample-calc" provider="java:RPC">
<parameter name="scope" value="Application"></parameter>
<parameter name="className" value="Calc.server.CalcServer"></parameter>
<parameter name="static" value="false"></parameter>
<parameter name="allowedMethods" value="*"></parameter>
<parameter name="allowedRoles" value="*"></parameter>
<operation name="add" returnQName="return" responseSuffix="Response">
<parameter name="arg1" type="ns2:int" mode="in"
xmlns:ns2="http://www.w3.org/2001/XMLSchema"></parameter>
<parameter name="arg2" type="ns3:int" mode="in"
xmlns:ns3="http://www.w3.org/2001/XMLSchema"></parameter>
</operation>
</service>
</deployment>
8-8
soapdd2wsdd
soapdd2wsdd
Name
soapdd2wsdd
Conversion of Web Service information management file
Synopsis
soapdd2wsdd -replace|-none [-sf urnfile] [-info infofile] [-i DDdir ] [-o
WSDDdir]
soapdd2wsdd -replace|-none [-sf urnfile] [ -M systemname ] [-info infofile]
[-i DDdir ] [-o WSDDdir]
Description
The soapdd2wsdd command converts the Web Service information management file (conversion origin)
used at the previous version and level into the Web Service information management file of the present
version and level (performs conversion ahead).
-replace
When a Web Service identifier of the same name as the conversion origin exists in the Web Service
information management file conversion ahead, the conversion origin file is overwritten.
-none
When a Web Service identifier of the same name as the conversion origin exists in the Web Service
information management file conversion ahead, the Web Service information in the conversion origin is
annulled.
-info infofile
The conversion result of the Web Service identification name is output to the file. When this option is
omitted, the result is output to standard output.
-i DDdir
The directory in which the Web Service information management file exists in the conversion origin is
specified.
When this option is omitted, it is considered that the following directories were specified:
C:\Interstage\F3FMsoap\etc\DeployService
8-9
Chapter 8: SOAP Service Operation Commands
For a default system: /opt/FJSVsoap/etc/DeployService
For a multi-system: /opt/FJSVsoap/MI/system name/etc/DeployService
/opt/FJSVsoap/etc/DeployService
-o WSDDdir
The directory that stores the Web Service information management file conversion ahead is specified.
When this option is omitted, it is considered that the following directories were specified:
C:\Interstage\F3FMsoap\etc\DeployService
For a default system: /opt/FJSVsoap/etc/DeployService
For a multi-system: /opt/FJSVsoap/MI/system name/etc/DeployService
/opt/FJSVsoap/etc/DeployService
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
Messages
The results of the command are displayed on the command execution screen.
Notes
8-10
•
Do not execute this command while operating the Web Service Container.
•
Only users belonging to the Administrators local group can execute this command.
•
Only the superuser is authorized to execute this command.
soapdd2wsdd
Examples
soapdd2wsdd -replace -info C:\temp\info.txt -i C:\Interstage\F3FMsoap\etc -o
c:\interstage\F3FMsoap\etc
soapdd2wsdd -replace -info /tmp/info.txt -i /opt/FJSVsoap/etc -o
/opt/FJSVsoap/etc
8-11
Chapter 8: SOAP Service Operation Commands
soapgwstartclgw
Name
soapgwstartclgw
Start the CORBA/SOAP client gateway.
Synopsis
soapgwstartclgw
soapgwstartclgw [ -M systemname ] [ -init ]
soapgwstartclgw [ -init ]
Description
The soapgwstartcgw command activates the CORBA/SOAP client gateway and the data conversion
servant.
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-init
Specify when the CORBA/SOAP client gateway is initialized and started. If this option is omitted, the
data conversion servant before stopped is recovered.
Messages
The results of the command are displayed on the command execution screen.
8-12
soapgwstartclgw
Notes
•
Only users belonging to the Administrators local group can execute this command.
•
Only the superuser is authorized to execute this command.
Examples
soapgwstartclgw
ISSOAP: INFO: issoap3018: Client Gateway is start.
soapgwstartclgw
UX: ISSOAP: INFO: issoap3018: Client Gateway is start.
8-13
Chapter 8: SOAP Service Operation Commands
soapgwstopclgw
Name
soapgwstopclgw
Stop the CORBA/SOAP client gateway.
Synopsis
soapgwstopclgw
soapgwstopclgw [ -M systemname ] [ -kill ]
soapgwstopclgw [ -kill ]
Description
The soapgwstopclgw command stops the CORBA/SOAP client gateway.
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-kill
Forcibly terminates the CORBA/SOAP client gateway.
Terminates the CORBA/SOAP client gateway. Note that the CORBA/SOAP client gateway does not
terminate until all requests received are processed. When the -kill option is specified, the
CORBA/SOAP client gateway is terminated by canceling the requests that are not processed yet.
Messages
The results of the command are displayed on the command execution screen.
Upon successful completion, nothing is displayed.
8-14
soapgwstopclgw
Notes
•
Only users belonging to the Administrator’s local group can execute this command.
•
Only the superuser is authorized to execute this command.
Example
soapgwstopclgw
8-15
Chapter 8: SOAP Service Operation Commands
soapgwaddclgw
Name
soapgwaddclgw
Registers/Activates the data conversion servant
Synopsis
soapgwaddclgw -id IntfID -url URL -urn URN -n bindname
[-class classname] [ -SSL ] [-proxy host:port]
-proxyauth username:password [-replace]
soapgwaddclgw [-M systemname ] -id IntfID -url URL -urn URN -n bindname
[-class classname] [ -SSL ] [-proxy host:port]
-proxyauth username:password [-replace]
Description
This command registers the data conversion servant with the CORBA/SOAP client gateway.
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-id IntfID
Specify the ID of the interface repository to be operated as a gateway.
-url URL
Specify the URL of the Web Service container. The coding format is as follows:
http://host name: port number/Web application identifier/servlet/servlet name
The port number can be omitted. If the port number is omitted, the HTTP standard No. 80 is used.
A URL length of 255 bytes or less can be specified.
-urn URN
Specify the Web Service identifier to be registered or which is already registered with Web Service
information management.
A Web Service identifier length of 255 bytes or less can be specified.
8-16
soapgwaddclgw
Moreover, specify the following for URL when basic authentication is required.
http://user name:password@host name: port number/Web application identifier/servlet/servlet
name
The description form is as follows.
http://aaa:bbb@localhost/soap_admin/servlet/WSContainer
-n bindname
Specify the object name to be registered with the Naming Service.
-class classname
Specify the data conversion servant class name.
If this option is not specified, an appropriate data conversion servant is determined from the repository
ID.
-SSL
Specify -SSL to conduct SSL communication with the CORBA client.
If this option is not specified, normal communication is conducted.
If the SSL option is specified, an environment for SSL communication must be provided.
If the environment is not suitable for SSL communication, the communication fails.
-proxy host:port
When a proxy is used, specify the host name (or IP address) of the proxy server.
If this option is not specified, a proxy is not used.
The coding format is as follows:
Host name: port number
-proxyauth username:password
Specify the user-name and password for proxy authentication.
When the -proxyauth option is not specified, the proxy authentication setting is not implemented.
The description form is as follows.
User name for proxy authentication : password for proxy authentication
-replace
Specify when re-registering a data conversion servant. It becomes the usual registration when there is
no data conversion servant overwritten.
Messages
The results of running commands are displayed on the command screen. Nothing is displayed after
normal termination.
8-17
Chapter 8: SOAP Service Operation Commands
Notes
•
Please start service of a CORBA/SOAP client gateway by one of the methods shown below where
the CORBA service is started before executing this command.
−
soapgwstartclgw command
−
The following services are chosen from a service screen ([control panel]-[service]), and the
state of service is made "start".
"CORBA_SOAP ClientGW" service
•
Only users belonging to the Administrators local group can execute this command.
•
Start a CORBA/SOAP client gateway before executing this command.
•
Only the superuser is authorized to execute this command.
Example
soapgwaddclgw -id IDL:ODsample/stringtest:1.0 -n ODsample::stringtest
-url http://hostname:12000/soap_admin/servlet/WSContainer -urn
urn:ODsample::stringtest.
8-18
soapgwdelclgw
soapgwdelclgw
Name
soapgwdelclgw
Deletes the data conversion servant.
Synopsis
soapgwdelclgw -id IntfID
soapgwdelclgw [-M systemname ] -id IntfID
Description
This command deletes the data conversion servant from the CORBA/SOAP client gateway.
After all requests accepted from the CORBA client application are processed, the data conversion
servant is deleted.
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-id IntfID
Specify the ID of the interface repository operating as a gateway.
Messages
Execution results of this command are output on the screen where the command was executed.
Nothing is displayed after normal termination.
8-19
Chapter 8: SOAP Service Operation Commands
Notes
•
If the data conversion servant is communicating, it is deleted after the communication is finished.
•
Please start service of a CORBA/SOAP client gateway by one of the methods shown below where
CORBA service is started before executing this command.
−
soapgwdelclgw command
−
The following services are chosen from a service screen ([control panel]-[service]), and the
state of service is made "start".
"CORBA_SOAP ClientGW" service
•
Only users belonging to the Administrators local group can execute this command.
•
Start a CORBA/SOAP client gateway before executing this command.
•
The user belongs to an Administrators local group to execute this command.
•
Only the superuser is authorized to execute this command.
Example
soapgwdelclgw -id IDL:ODsample/stringtest:1.0
8-20
soapgwlistclgw
soapgwlistclgw
Name
soapgwlistclgw
Lists the data conversion servants of the CORBA/SOAP client gateway.
Synopsis
soapgwlistclgw [ -id IntfID ]
soapgwlistclgw [ -M systemname ] [ -id IntfID ]
Description
This command displays information about data conversion servants registered with the CORBA/SOAP
client gateway.
-M systemname
The system name of a multi-system is specified.
If this option is omitted, the default system is specified as the target.
-id IntfID
Specify the ID of the interface repository operating as a gateway.
If this option is omitted, interface repository IDs of the data conversion servants registered with the
CORBA/SOAP client gateway are listed.
Messages
Execution results of this command are output on the screen where the command was executed.
−
When the repository ID is omitted
RepositoryID: Repository ID
ClassName:
−
Data conversion servant's class name
When the repository ID is specified
RepositoryID: Repository ID
URL:
URL of the Web Service container
8-21
Chapter 8: SOAP Service Operation Commands
URN:
Web Service identifier
BindName:
Object name of the data conversion servant registered with the Naming Service
ClassName:
Data conversion servant class name
SSL: “true” : SSL communication with the CORBA client application is set.
“false” : SSL communication with the CORBA client application is not set.
proxyhost:
When proxy is used : proxy name.
When proxy is not used : “default”
proxyport:
When proxy is used : port number of proxy
When proxy is not used : 0000
proxyuser:
User name for proxy authentication
The following cases are not displayed.
- Proxy is not used.
- The password for the proxy authentication is not set.
proxypasswd: Password of user-name for proxy authentication
The following cases are not displayed.
- Proxy is not used.
- The password for the proxy authentication is not set.
Notes
•
Please start service of a CORBA/SOAP client gateway by one of the methods shown below where
the CORBA service is started before executing this command.
−
soapgwlistclgw command
−
Choose the following service from a service screen ([Control Panel] - [Service]), and select
"start" for the service.
"CORBA_SOAP ClientGW" service
8-22
•
Start a CORBA/SOAP client gateway before executing this command.
•
Only the superuser is authorized to execute this command.
soapgwlistclgw
Examples
When the repository ID is omitted
---------------------------------------------------------------------------RepositoryID : IDL:ODsample/stringtest:1.0
ClassName : ODsample._stringtestSOAPGWServant
---------------------------------------------------------------------------RepositoryID : IDL:ODsample/structtest:1.0
ClassName : ODsample._structtestSOAPGWServant
----------------------------------------------------------------------------
8-23
Chapter 8: SOAP Service Operation Commands
soapidl2wsdl
Name
soapidl2wsdl
IDL-WSDL converter
Synopsis
soapidl2wsdl [-sinfofilename] [-infofilename] [-Idir] [-Dname[=val]] [-o
basename] [IDLfile]
soapidl2wsdl [-sinfofilename] [-infofilename] [-Idir] [-Dname[=val]] [-o
basename] [-M systemname] [IDLfile]
Description
This command converts contents described in the IDL (Interface Definition Language) file specified by
IDLfile into WSDL (Web Services Description Language). If IDLfile is omitted, Foo.idl is assumed. The
file name must be in the format of "XX.idl" (XX is arbitrary).
If the IDL file contains any of the following definitions, processing is stopped due to a conversion error:
8-24
•
If "oneway" is specified as an operation attribute
•
If any of the data types is contained:
−
union
−
fixed
−
long double
soapidl2wsdl
Mapping of the data types is performed based on the following table:
CORBA data type
SOAP data type
long
xsd:int
unsigned long
xsd:unsignedInt
short
xsd:short
unsigned short
xsd:unsignedShort
long long
xsd:long
float
xsd:float
double
xsd:double
boolean
xsd:boolean
char
xsd:string
wchar
xsd:string
octet
xsd:unsignedByte
string
xsd:string
wstring
xsd:string
enum
Enumeration type defined in conversion to the SOAP code
array
Array type defined in conversion to the SOAP code
sequence
Array type defined in conversion to the SOAP code
struct
Structure type defined in conversion to the SOAP code
Object
xsd:string
interface
xsd:string
Notes
A data type starting with xsd: is defined in http://www.w3.org/2001/XMLSchema.
Generation File
Contents converted into WSDL are stored in a file obtained by changing the extension of the IDL file into
wsdl.
Options
The following explains the options of this command. "O" in the table indicates that the item can be
omitted and "X" in the table indicates that the item cannot be omitted.
-sinfofilename
Specify the file name of the service information file as filename.
If this parameter is omitted, service information in the WSDL file remains incomplete.
8-25
Chapter 8: SOAP Service Operation Commands
The format of the service information file is as follows:
(a) Overall configuration
Describe the service information file in the following format. If not otherwise specified, the sequence of
appearance of each tag is from top to bottom.
Table 8-1 Overall Configuration
Tag
Omission
Meaning
<?xml version=”1.0”
encoding="value of encoding"?>
X
Tag to define the format version and description code
of the XML file. Specify the value designated by the
system as the value of encoding.
When using the Notepad of Windows, Shift-JIS must
be specified as the value of encoding.
<definitions>
X
Tag to indicates the start of definition information
X
Tag to indicate the start of service information
Tag indicated in (b)
<service name=” name”>
Specify the string of the name value described under
the service tag in the WSDL file into which this
information is incorporated.
There may be multiple pairs of service -/service in
one service information file.
Tag indicated in (c)
</service>
X
Tag to indicate the end of service information
</definitions>
X
Tag to indicates the end of definition information
(b) Definition information tag
Tags of definition information for the overall service information in which multiple services are defined
are as follows:
Table 8-2 Definition Information Tag
Tag
Omission
Meaning
<wsdlns>string</wsdlns>
O
Tag to define the string indicating the namespace of
WSDL
Default: urn:WSDL-file-name
<soap>string</soap>
O
Tag to define the string indicating the WSDL
namespace for WSDL SOAP binding
Default: http://schemas.xmlsoap.org/wsdl/soap/
<xsd>string</xsd>
O
Tag to define the string indicating the namespace of
the schema defined in XSD
Default: http://www.w3.org/2001/XLMSchema
8-26
soapidl2wsdl
Tag
Omission
Meaning
<wsdl>string</wsdl>
O
Tag to define the string indicating the WSDL
namespace for the WSDL framework
Default: http://schemas.xmlsoap.org/wsdl/
<http>string</http>
O
Tag to define the string indicating the WSDL
namespace for WSDL HTTP GET and POST
Default: http://schemas.xmlsoap.org/wsdl/http
<mime>string</mime>
O
Tag to define the string indicating the WSDL
namespace for the WSDL MIME binding
Default: http://schemas.xmlsoap.org/wsdl/mime
<soapenc>string</soapenc>
O
Tag to define the string indicating the encoding
namespace defined in SOAP1.1
Default: http://schemas.xlmsoap.org/soap/encoding/
<soapenv>string</soapenv>
O
Tag to define the string indicating the envelope
namespace defined in SOAP1.1
Default: http://schemas.xlmsoap.org/soap/envelope/
<soaphttp>string</soaphttp>
O
Tag to define the string indicating the transport to be
used for SOAP in the binding of a SOAP binding
element.
Default: http://schemas.xmlsoap.org/soap/http
<soapname>string</soapname>
O
Tag to define the string indicating the transport to be
used for SOAP in the binding of a SOAP binding
element. This value is equivalent to the Web Service
identifier.
Default: urn:WSDL-file-name
<schemas>string</schemas>
O
Tag to define the string indicating the name space of
schema.
Default: urn:Fujitsu-Soap-Service-Data
8-27
Chapter 8: SOAP Service Operation Commands
(c) Tags of one service
Tags of definition information for one service are as follows:
Table 8-3 Definition Information Tags for One Service
Tag
Omission
Meaning
<documentation>string</docume
ntation>
O
Tag to indicate the comment strings to the services
<port name=”name”?
X
Default (evaluated as an empty string)
Tag to indicate the start of port information
In "name", specify the string of the name value
described under the port tag in the WSDL file into
which this information is incorporated.
There may be multiple pairs of port -/port in one
service.
<location>string</location>
X
Tag to indicate the URL string of the server that
provides the services.
</port>
X
Tag to indicate the end of port information
-infofilename
Specify the name of IDL-WSDL ID information file in filename. When a file is to be generated in the
WSDL file, the file name is replaced with the one defined in this file. If this option is omitted, the name in
IDL is adopted. Describe the IDL-WSDL ID information file in the following format.
<module>*
<name>string</name>
<name_to>string</name_to>?
<interface>*
<name>string</name>
<name_to>string</name_to>?
<typedef>*
<name>string</name>
<name_to>string</name_to>?
</typedef>
<exception>*
<name>string</name>
<name_to>string</name_to>?
</exception>
<method>*
<name>string</name>
<name_to>string</name_to>?
</method>
</interface>
</module>
Module information
Interface information
typedef information (including array, struct, and enum)
Exception information
Method information
*) 0 or more specifiable
?) 0 or 1 specifiable
In <name>string</name>, specify the name of the conversion source (IDL).
In <name_to>string</name_to>, specify the name after the conversion (WSDL).
8-28
soapidl2wsdl
If the extension of IDL need not be converted, <name_to>string</name_to> can be omitted.
-Idir
Adds dir to the directories to be searched of the file specified in the #include statement. This option can
be specified multiple times. In this case, directories are searched in the order specified.
-Dname[=val]
Defines the macro name. This has the same meaning as "#define name val" at the start of the IDL file.
Omitting "=val" has the same meaning as "#define name".
-o basename
Changes xx in the name of the file generated from xx.idl to basename.
-M systemname
The system name of a multi-system is specified.
Notes
•
The suffix "idl" of the IDL file must be lower-case. If the suffix is upper-case after importing using
the ftp command, change upper-case suffix to the lower-case one and execute the soapidl2wsdl
command.
•
Since the soapidl2wsdl command uses the following words as keywords, these words must not be
used when creating an IDL file:
cdr, con, env, failed, method, object, reply_status, request, response_expected, result, type
•
Any parameter that does not begin with "-" is handled as an IDL file name.
•
If any content in the service information file specified by the -sinfo option is incorrect, other
messages than those shown as error messages are displayed in Japanese. In such cases, correct
errors according to the error messages and re-execute the soapidl2wsdl command.
•
When executing the soapidl2wsdl command, "CORBA service client" must be installed. Required
environmental variables are set during installation. Check whether the following environmental
variables are set:
OD_HOME = C:\Interstage\ODWIN
PATH = C:\Interstage\ODWIN\bin
•
If the soapidl2wsdl command is forcibly stopped by, for example, [ctr]+[c], work files (generated
under TEMP environment\tmp or TMP environment \tmp)) may remain. In such cases, delete the
following file:
“Windows System Directory”\temp\IDLc.*
8-29
Chapter 8: SOAP Service Operation Commands
•
When executing the soapidl2wsdl command, "CORBA service client" must be installed. Required
environmental variables are set during installation. Check whether the following environmental
variables are set:
OD_HOME=/opt/FSUNod
•
If the soapidl2wsdl command is forcibly stopped by, for example, [ctrl]+[c], work files (generated
under /tmp)) may remain. In such cases, delete the following file:
/tmp/IDLc.*
Error Messages
Error Messages During Conversion
Can't open file :n
Error
File "file" cannot be opened.
System error number: n
Read failed file
Error
Failed to read from "file".
Write failed file
Error
Failed to write to "file".
MALLOC:name: n Bytes: Not enough memory
Error
n bytes of "name" cannot be allocated due to insufficient memory.
Syntax error:string
Error
"string" definition is syntactically incorrect. Or, a content indicated by "string" is incorrect.
Structure member redeclaration of name
Error
Structure member "name" was redefined.
Union-switch member redeclaration of name
Error
Union-switch member "name" was redefined in the union.
8-30
soapidl2wsdl
Duplicate case in union-switch, label
Error
Cases with the same label were defined for the union-switch of the union.
Out of array dimension
Error
The dimension of the array is not supported
Identifier redeclaration of name
Error
Identifier "name" was redefined.
Illegal scoping name
Error
"name" is not correct as a name to be used in scope.
name undefined data type
Error
"name" is not defined as a data type.
name is not data type
Error
"name" is not a data type.
Illegal union-switch data type, name
Error
"name" is not correct as a union-switch data type.
Identifier too long.max(n)
Error
Identifier exceeds the maximum length. The maximum length is (n).
name undefined exception
Error
"name" is not defined as an exception.
name is not exception
Error
"name" is not defined as an exception.
Warning:duplicate raises name exception
Warning
"name" exception is doubly defined in the Raises clause.
8-31
Chapter 8: SOAP Service Operation Commands
name undefined interface
Error
"name" is not defined as an interface.
name is not interface
Error
"name" is not an interface.
Warning: duplicate inheritance name interface
Warning
"name" interface is inherited twice.
name undefined constant
Error
"name" is not defined as a constant.
name is not constant
Error
"name" is not a constant.
Illegal constant type, name
Error
"name" is not correct as a constant type.
Warning:operator operator, out of range
Warning
The argument on the right of the shift operator "operator" is out of range.
Operator operator, division by zero
Error
The second expression of the operator "operator" is 0.
Overflow, Floating point value
Error
An overflow of the floating-point value occurred.
Bad assignment values, type1 : type2
Error
Since type1 and type2 are of different types, assignment of these values is not possible.
Warning:overflow signed long
Warning
An overflow of the signed long occurred.
8-32
soapidl2wsdl
Illegal expression, type
Error
"type" is not a correct exception definition.
Syntax error hexadecimal, string
Error
A character that cannot be specified in the hexadecimal notation is specified in "string".
Syntax error octal, string
Error
A character that cannot be specified in the octet notation is specified in "string".
Undefined escape character, string
Error
"string" is not defined as an escape character.
Unsupported multiple source file
Error
Multiple IDL files are specified.
Positive-integer constant only
Error
Only positive integer constants can be specified.
Ambiguous variable usage
Error
The applicable variable declaration is undefined.
Can't close "file-name"
Error
"file-name" file cannot be closed.
REALLOC:"name" : n Bytes
Error
Failed to allocated n bytes of memory in the "name" area.
CORBA_ORB_init ERROR
Error
CORBA Service (ObjectDirector) has not been started.
CORBA_ORB_BOA_init ERROR
Error
CORBA Service (ObjectDirector) has not been started.
8-33
Chapter 8: SOAP Service Operation Commands
can't make temp list
Error
Work file cannot be created due to insufficient resources.
Unsupported data type : "type"
Error
Defined "type" is not supported.
Unsupported operation type : oneway
Error
Specified operation attribute (oneway) is not supported.
Other Messages
An error message is displayed in the following format if the IDL file conversion fails due to an
environment setting error or communication error when the soapidl2wsdl command carries out WSDL
mapping using the interface repository and Naming Service.
Processing phase (I/R): processing name, function name
IDL exception code
Idl2wsdl: Stop.processing phase status = end status.
Processing phase
IDLparser:
IDL file parsing
IDLwsdlcg:
WSDL mapping
IDLinst:
Registration with the interface repository, change, and deletion
destory_rep:
End processing
Processing name, function name
Specific information to identify error locations of the soapidl2wsdl command is displayed.
Exception Codes
The following exception codes are notified as system exceptions:
IDL:CORBA/StExcep/UNKNOWN:1.0
Unknown exception
IDL:CORBA/StExcep/BAD_PARAM:1.0
Invalid parameter
IDL:CORBA/StExcep/NO_MEMORY:1.0
Out of memory detected.
IDL:CORBA/StExcep/IMP_LIMIT:1.0
The upper limit of the started server applications is reached.
IDL:CORBA/StExcep/COMM_FAILURE:1.0
Communication error. Communication with the interface repository service cannot be conducted.
IDL:CORBA/StExcep/INV_OBJREF:1.0
Invalid object reference
8-34
soapidl2wsdl
IDL:CORBA/StExcep/NO_PERMISSION:1.0
Method execution right not granted.
IDL:CORBA/StExcep/INTERNAL:1.0
An internal error of the CORBA Service (ObjectDirector) occurred.
IDL:CORBA/StExcep/MARSHAL:1.0
A parameter/result marshaling error occurred.
IDL:CORBA/StExcep/INITIALIZE:1.0
Failed to initialize the CORBA Service (ObjectDirector).
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The interface repository service has not been started.
IDL:CORBA/StExcep/BAD_TYPECODE:1.0
Invalid type code
IDL:CORBA/StExcep/BAD_OPERATION:1.0
Invalid operation
IDL:CORBA/StExcep/NO_RESOURCES:1.0
Insufficient resources for the request
IDL:CORBA/StExcep/NO_RESPONSE:1.0
No response from the interface repository service
IDL:CORBA/StExcep/PERSIST_STORE:1.0
Persistent storage failed.
IDL:CORBA/StExcep/BAD_INV_ORDER:1.0
Routine invocation is abnormal.
IDL:CORBA/StExcep/TRANSIENT:1.0
An error occurred during transition and the request has been reissued.
IDL:CORBA/StExcep/FREE_MEM:1.0
Failed to release memory.
IDL:CORBA/StExcep/INV_IDENT
Invalid identifier syntax
IDL:CORBA/StExcep/INV_FLAG:1.0
Invalid flag
IDL:CORBA/StExcep/INTF_REPOS:1.0
An access error of the interface repository occurred.
IDL:CORBA/StExcep/CONTEXT:1.0
A context object error occurred.
8-35
Chapter 8: SOAP Service Operation Commands
IDL:CORBA/StExcep/OBJ_ADAPTER:1.0
An object adapter error occurred.
IDL:CORBA/StExcep/DATA_CONVERSION:1.0
A data conversion error occurred.
The following shows system exceptions that may occur due to environment setting errors and action to
be taken.
Handling Exception Codes
Exception Code
IDL:CORBA/StExcep/NO_MEMORY:1.0
Cause
Insufficient memory was detected.
Action
Increase memory or the swap area.
Exception code
IDL:CORBA/StExcep/COMM_FAILURE:1.0
Cause
Communication with the interface repository failed due to one of the following causes:
8-36
a)
Because the server machine is not turned on or the CORBA Service is not started, communication
with the server failed.
b)
Processing of the interface repository was not completed with the setting (implicit value: 60 s) of
period_receive_timeout of config.
c)
An attempt was made to process data exceeding max_UNO_IIOP_msg_size (implicit value: 65536
bytes) of config (either on the server or client).
d)
The number of requests to be processed on the server exceeded max_IIOP_resp_con (implicit
value: 8) of config.
e)
A LAN failure occurred.
f)
A setting in inithost is incorrect.
g)
The interface repository service for value interface has not been started (when, for example,
developing an EJB application).
soapidl2wsdl
Action
Action to be taken for each is as follows:
a)
Turn on the server machine and start the interface repository server.
b)
Increase the setting of period_receive_timeout of config.
c)
Increase max_UNO_IIOP_msg_size of config for both the server and client.
d)
The number of requests to be processed on the server increases max_IIOP_resp_con of config.
e)
Check the LAN environment for any failures. If any failure is detected, repair the LAN.
f)
Set inithost correctly.
g)
When developing an EJB application, specify the EJB options in Interstage initialization.
Note:
After action is taken in b), the startup of the interface repository may fail. Take appropriate action after
checking output messages. For details of the messages, refer to Messages.
Exception code
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Cause
The server of the interface repository has not been stared.
Action
Start the interface repository server. If the server cannot be started, review the environment settings
and retry. When developing an EJB application, specify the EJB options in Interstage initialization.
Exception code
IDL:CORBA/StExcep/NO_RESOURCES:1.0
Cause
An object to call the interface repository service could not be generated.
Or, the server of the same implementation ID is already started.
Action
Retry after waiting for a while. Or, stop the server with the same implementation ID or review the
implementation ID. For details on exception information, see "Exception information."
End Status
0:
Normal end
2:
Syntax error
3:
Unsupported processing called
4:
Other errors were detected.
8-37
Chapter 8: SOAP Service Operation Commands
Examples
1.
Convert the IDL file module.idl into the WSDL file module.wsdl.
> soapidl2wsdl module.idl
2.
Convert the IDL file module.idl into the WSDL file /home/wsdl/func.wsdl.
> soapidl2wsdl -o c:\home\wsdl\func module.idl
1.
Convert the IDL file module.idl into the WSDL file module.wsdl.
> soapidl2wsdl module.idl
2.
Convert the IDL file module.idl into the WSDL file /home/wsdl/func.wsdl.
> soapidl2wsdl -o /home/wsdl/func module.idl
8-38
soapwsdl2idl
soapwsdl2idl
Name
soapwsdl2idl
WSDL-IDL converter
Synopsis
soapwsdl2idl
WSDLfile IDLfile [ IDENTfile ]
Description
The soapwsdl2idl command converts data in a Web Services Description Language (WSDL) file
specified in the WSDLfile to interface definition language (IDL) data. It also creates a Web Service
information file. For details on the Web Service information file, refer to the SOAP Service User's Guide.
A conversion error occurs and processing is stopped if the WSDL file is defined as follows:
•
No SOAP protocol binding exists.
•
The style attribute of the <soap:binding> element is not "rpc".
•
A data type that cannot be converted into a data type in IDL is specified (Any SOAP data type that
is not listed below is specified).
8-39
Chapter 8: SOAP Service Operation Commands
XML data type
CORBA data type
xsd:int
long
xsd:unsignedInt
unsigned long
xsd:short
short
xsd:unsignedShort
unsigned short
xsd:long
long long
xsd:float
float
xsd:double
double
xsd:boolean
boolean
xsd:string
wstring
xsd:unsignedByte
octet
Enumeration type defined in conversion to
the SOAP code
enum
- Must be defined in element <type>.
- An error occurs if the base is not string.
Array type defined in conversion to the SOAP
code
Sequence (if one-dimensional and variable length)
Array
- Must be defined in element <type>.
Structure type defined in conversion to the
SOAP code
struct
- Must be defined in element <type>.
Notes
A data type starting with xsd: is defined in http://www.w3.org/2001/XMLSchema.
If an unsupported data type is used in the WSDL file, the error message below may be displayed. In
such a case, review the data type definition in the type element in element <part> and the data type
definition in element <types>.
wsdl2idl: null structure: name = string
•
If a method that has the same in/inout parameter names is overloaded.
•
If a method that does not contain the in/inout parameters is overloaded.
WSDLfile
Specify the name of the WSDL file to be an input of the command.
IDLfile
Specify the name of the IDL file to be generated.
IDENTfile
Specify the IDL-WSDL ID information file. In this file, the correspondence between the names in the IDL
file and those in the WSDL file are stored. If this file omitted, no IDL-WSDL ID information file is
generated. This file is needed to generate CORBA/SOAP gateway programs.
8-40
soapwsdl2idl
Messages
The WSDL file is omitted.
Error
WSDL file was omitted.
The IDL file is omitted.
Error
IDL file was omitted.
Notes
•
If an error is detected in the XML schema part in WSDL analysis with WSDL, the error message
shown below is displayed. The line number and column number do not correspond to those in the
WSDL.
Wsdl2idl: An error is detected in WSDL analysis: ......
The error is detected in column -1 on 3rd line.
•
If element <service> is not present in the WSDL file, it cannot be converted to an IDL file correctly.
Always check if element <service> is present in the WSDL file before converting it.
•
The suffix of each file to be specified as arguments of the command must be lower-case. If the
suffix is upper-case after importing using the ftp command, change upper-case suffix to the lowercase one and execute the soapwsdl2idl command.
•
If an error is detected in the WSDL file, a message unlisted in "Error messages" is displayed.
Correct the error according to the error message and reexecute the soapwsdl2idl command. If an
error is detected during analysis of schema tag written in the WSDL file, an error message is
displayed for the schema tag. Check for errors in the schema tag and attribute tags depending on
the displayed messages.
•
The suffix of each file to be specified as arguments of the command must be lower-case. If the
suffix is upper-case after importing using the ftp command, change upper-case suffix to the lowercase one and execute the soapwsdl2idl command.
•
If an error is detected in the WSDL file, a message unlisted in "Error messages" is displayed.
Correct the error according to the error message and re-execute the soapwsdl2idl command. If an
error is detected during analysis of schema tag written in the WSDL file, an error message is
displayed for the schema tag. Check for errors in the schema tag and attribute tags depending on
the displayed messages.
8-41
Chapter 8: SOAP Service Operation Commands
End Status
0:
Normal end
1:
Errors were detected.
Example
The WSDL file module.wsdl is converted into the IDL file module.idl.
soapwsdl2idl module.wsdl module.idl
8-42
soapsecsignconf
soapsecsignconf
Name
soapsecsignconf
Setting operations for adding a SOAP digital signature.
Synopsis
(1) To add/change the setting for adding a SOAP digital signature
soapsecsignconf -add [-f filename] -signid signid [-storefile filename]
[-storepass password] [-keyalias alias]
[-keypass password] [-referenceuri uri]
[-referencexpath xpath] [-keyname keyname] [nocertificate]
(2) To delete the setting for adding a SOAP digital signature
soapsecsignconf -del [-f filename] -signid signid
(3) To display a list of settings for adding a SOAP digital signature
soapsecsignconf -list [-f filename]
(4) To display detailed settings for adding a SOAP digital signature
soapsecsignconf -view [-f filename] -signid signid
(1) To add/change settings for adding a SOAP digital signature
soapsecsignconf -add [-M systemname] [-f filename] -signid signid
[-storefile filename] [-storepass password] [-keyalias
alias]
[-keypass password] [-referenceuri uri] [-referencexpath
xpath]
[-keyname keyname] [-nocertificate]
8-43
Chapter 8: SOAP Service Operation Commands
(2) To delete settings for adding a SOAP digital signature
soapsecsignconf -del [-M systemname] [-f filename] -signid signid
(3) To display a list of settings for adding a SOAP digital signature
soapsecsignconf -list [-M systemname] [-f filename]
(4) To display detailed settings for adding a SOAP digital signature
soapsecsignconf -view [-M systemname] [-f filename] -signid signid
Description
The soapsecsignconf command adds/changes and deletes settings for adding a SOAP digital signature
and displays a list of settings for adding a SOAP digital signature and details on the settings.
-M systemname
Specify the target multisystem name.
If this option is omitted, the default system is specified as a target.
-add
Adds or changes the setting specified in the -signid option for adding a SOAP digital signature.
Specify this option always as the first command option.
-del
Deletes the setting specified in the -signid option for adding a SOAP digital signature.
Specify this option always as the first command option.
-list
Displays a list of settings for adding a SOAP digital signature.
Specify this option always as the first command option.
-view
Displays details on the settings specified in the -signid option for adding a SOAP digital signature.
Specify this option always as the first command option.
-f filename
Specify the name of a file to store the settings for adding a SOAP digital signature.
If this option is omitted, the setting is stored as follows:
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
8-44
soapsecsignconf
/opt/FJSVsoap/conf/issoapsecconf.xml
−
When the default is specified in the -M option
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
When a system name other than the default is specified in the -M option
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/conf/issoapsecconf.xml
-signid signid
Specify the identifier (Web Service identifier) of the setting for adding a SOAP digital signature that
adds/changes, deletes, or displays details of the target.
-storefile filename
Specifies the name of the certificate management file that contains the private key used to add a SOAP
digital signature.
If this option is omitted in a client system environment or in a certificate environment that is configured
using an old version, the certificate management file created with the soapSetSecurity command is used.
In other environments, the certificate management file created in the Interstage certificate environment
is used.
-storepass password
Specify a password to access the certificate management file specified in the -storefile option.
-keyalias alias
Specify an alias of the private-key used for adding a SOAP digital signature.
If this option is omitted in a client system environment or in a certificate environment that is configured
using an old version, the private key created with the soapSetSecurity command is used to add SOAP
digital signatures.
In other environments, the SSL definition name specified with com.fujitsu.interstage.soapx.websec of
config.properties is used to add SOAP digital signatures.
-keypass password
Specify a password to decrypt the private-key specified in the -keyalias option.
-referenceuri uri
Specify the SOAP digital signature target.
For this specification, use reference to an element with an ID type attribute value ("#" + "target element
ID type attribute value") or URI to view the attached data.
8-45
Chapter 8: SOAP Service Operation Commands
If the -referenceuri and -referencexpath options are omitted, the SOAP body is specified as a digital
signature target. When there are multiple signature targets, multiple -referenceuri or -referencexpath
options can be specified.
-referencexpath xpath
Specify the signature target by using an XPath expression.
If the -referenceuri and -referencexpath options are omitted, the SOAP body is selected as a signature
target. When there are multiple signature targets, multiple -referenceuri or -referencexpath options can
be specified.
-nocertificate
Specify this option when a site certificate that corresponds to the private-key used for adding a SOAP
digital signature is not attached to the SOAP digital signature.
-keyname keyname
Specify the signatory name to be written.
This name is used as information for a SOAP message receiver to determine which site certificate is
used for SOAP digital signature verification. Write a value such as an e-mail address with consent of
the SOAP digital signature verifier of the signatory name.
Notes
•
If this command is used to add or delete settings for adding a SOAP digital signature, the Web
Service information edit tool or soapmodifydd command must be used to specify whether a SOAP
digital signature is to be added.
Examples
1.
To add/change settings for adding a SOAP digital signature.
> soapsecsignconf -add -signid urn:sample1 -referenceuri ‘#body’
2.
To delete settings for adding a SOAP digital signature.
> soapsecsignconf -del -signid urn:sample1
3.
To display a list of settings for adding a SOAP digital signature.
> soapsecsignconf –list
ID=urn:sample1
ID=urn:sample2
ID=urn:sample3
4.
To display detailed settings for adding a SOAP digital signature.
> soapsecsignconf -view -signid urn:sample1
ID=urn:sample1
Reference uri=#body
8-46
soapsecverifyconf
soapsecverifyconf
Name
soapsecverifyconf
Setting operations for verifying a SOAP digital signature.
Synopsis
(1) To add/change the setting for verifying a SOAP digital signature
soapsecverifyconf -add [-f filename] -verifyid verifyid [-storefile
filename]
[-storepass password] [-keyalias alias] [-keyname
keyname]
(2) To delete the setting for verifying a SOAP digital signature
soapsecverifyconf -del [-f filename] -verifyid verifyid
(3) To display a list of settings for verifying a SOAP digital signature
soapsecverifyconf -list [-f filename]
(4) To display detailed settings for verifying a SOAP digital signature
soapsecverifyconf -view [-f filename] -verifyid verifyid
(1) To add/change settings for verifying a SOAP digital signature
soapsecverifyconf -add [-M systemname] [-f filename] -verifyid verifyid
[-storefile filename] [-storepass password] [keyalias alias]
[-keyname keyname]
(2) To delete settings for verifying a SOAP digital signature
soapsecverifyconf -del [-M systemname] [-f filename] -verifyid verifyid
8-47
Chapter 8: SOAP Service Operation Commands
(3) To display a list of settings for verifying a SOAP digital signature
soapsecverifyconf -list [-M systemname] [-f filename]
(4) To display detailed settings for verifying a SOAP digital signature
soapsecverifyconf -view [-M systemname] [-f filename] -verifyid verifyid
Description
The soapsecverifyconf command adds/changes and deletes settings for verifying a SOAP digital
signature and displays a list of settings for verifying a SOAP digital signature and details on the settings.
-M systemname
Specify the target multi-system name.
If this option is omitted, the default system is specified as a target.
-add
Adds or changes setting specified in the -verifyid option for verifying a SOAP electron
Specify this option always as the first command option.
-del
Deletes the setting specified in the -verifyid option for verifying a SOAP digital signature.
Specify this option always as the first command option.
-list
Displays a list of settings for verifying a SOAP digital signature.
Specify this option always as the first command option.
-view
Displays details on settings specified in the -verifyid option for verifying a SOAP digital signature.
Specify this option always as the first command option.
-f filename
Specify the name of a file to store settings for verifying a SOAP digital signature.
If this option is omitted, the setting is stored as follows:
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
/opt/FJSVsoap/conf/issoapsecconf.xml
−
8-48
When the default is specified in the -M option
soapsecverifyconf
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
When a system name other than the default is specified in the -M option
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/conf/issoapsecconf.xml
-verifyid verifyid
Specify the identifier (Web Service identifier) of the setting for verifying a SOAP digital signature that
adds/changes, deletes, or displays details of the target.
-storefile filename
Specify the name of the certificate management file storing the certificate used for verifying the SOAP
digital signature.
If this option is omitted in a client system environment or in a certificate environment that is configured
using an old version, the certificate management file created with the soapSetSecurity command is used.
In other environments, the certificate management file created in the Interstage certificate environment
is used.
-storepass password
Specify a password to access the certificate management file specified in the -storefile option.
-keyalias alias
Specify an alias of the site certificate used for verifying the SOAP digital signature.
Use this option to verify a SOAP digital signature by using a site certificate stored in a certificate
management file if the site certificate of the signatory is not attached to the SOAP digital signature.
-keyname keyname
Specify the written signatory name.
Use this option to determine a site certificate used for a SOAP digital signature verification by checking
the signatory name if no site certificate is attached to the SOAP digital signature. Write a value such as
e-mail address with consent of the signatory.
Notes
•
If this command is used to add or delete settings for verifying a SOAP digital signature, the Web
Service information edit tool or soapmodifydd command must be used to specify whether a SOAP
digital signature is to be verified.
Examples
1.
To add/change settings for verifying a SOAP digital signature.
> soapsecverifyconf -add -verifyid urn:sample1 -storefile keystore –
storepass changeit
8-49
Chapter 8: SOAP Service Operation Commands
2.
To delete settings for verifying a SOAP digital signature.
> soapsecverifyconf -del -verifyid urn:sample1
3.
To display a list of settings for verifying a SOAP digital signature.
> soapsecverifyconf –list
ID=urn:sample1
ID=urn:sample2
ID=urn:sample3
4.
To display detailed settings for verifying a SOAP digital signature.
> soapsecverifyconf -view -verifyid urn:sample1
ID=id1
KeyStoreName=keystore
Storepass=********
8-50
soapsecencconf
soapsecencconf
Name
soapsecencconf
Operation of setting for using XML encryption
Synopsis
(1) To add/change settings for using the XML encryption
soapsecencconf -add [-f filename] -encid encid [-storefile filename]
[-storepass password]
-keyalias alias [-targeturi uri]
[-targetxpath xpath [true | false]] [-keyname keyname]
(2) To delete settings for using the XML encryption
soapsecencconf -del [-f filename] -encid encid
(3) To display a list of settings for using the XML encryption
soapsecencconf -list [-f filename]
(4) To display detailed settings for using the XML encryption
soapsecencconf -view [-f filename] -encid encid
(1) To add/change settings for using the XML encryption
soapsecencconf -add [-M systemname] [-f filename] -encid encid
[-storefile filename] [-storepass password] -keyalias alias
[-targeturi uri] [-targetxpath xpath [true | false]]
[-keyname keyname
(2) To delete settings for using the XML encryption
soapsecencconf -del [-M systemname] [-f filename] -encid encid
8-51
Chapter 8: SOAP Service Operation Commands
(3) To display a list of settings for using the XML encryption
soapsecencconf -list [-M systemname] [-f filename]
(4) To display detailed setting for using the XML encryption
soapsecencconf -view [-M systemname] [-f filename] -encid encid
Description
The soapsecencconf command adds/changes and deletes setting for using the XML encryption and
displays a list of settings for using the XML encryption and detailed settings.
-M systemname
Specify the target multi-system name.
If this option is omitted, the default system is specified as a target.
-add
Adds or changes setting specified in the -encid option for using the XML encryption.
-del
Deletes setting specified in the -encid option for using the XML encryption.
-list
Displays a list of setting stored in the setup file for using the XML encryption.
-view
Displays details on setting specified in the -encid option for using the XML encryption.
-f filename
Specify the name of a file to store settings for using the XML encryption.
If this option is omitted, the setting is stored in a setup file for using the XML encryption as follows:
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
/opt/FJSVsoap/conf/issoapsecconf.xml
−
When the default is specified in the -M option
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
8-52
When a system name other than the default is specified in the -M option
soapsecencconf
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/conf/issoapsecconf.xml
-encid encid
Specify the identifier (Web Service identifier) of the setting for the XML encryption that add/change,
delete, or display details of the target.
-storefile filename
Specify the name of the certificate management file storing the certificate used for verifying a SOAP
digital signature.
If this option is omitted, a certificate management file created with the soapSetSecurity command is
used.
-storepass password
Specify a password to access the certificate management file specified in the -storefile option.
-keyalias alias
Specify an alias of the site certificate used for the XML encryption.
-targeturi uri
Specify the encryption target.
For this specification, use reference to an element with an ID type attribute value ("#" + "target element
ID type attribute value") or URI to view the attached data.
If the -targeturi and -targetxpath options are omitted, the SOAP body contents are specified as the
encryption target. When there are multiple encryption targets, multiple -targeturi or -targetxpath options
can be specified.
-targetxpath xpath [true | false]
Specify the encryption target.
For this specification, use an XPath expression to specify the encryption target element.
When true is specified after the XPath expression, the contents of the specified element are specified as
the encryption target. If this value is omitted, it is assumed that false is specified and the specified
element is selected as the encryption target.
If the -targeturi and -targetxpath options are omitted, the SOAP body contents are specified as the
encryption target. When there are multiple encryption targets, multiple -targeturi or -targetxpath options
can be specified.
-keyname keyname
Specify the name of a private-key to decode data encrypted with the XML encryption.
This name is used as information for a SOAP message receiver to determine which private-key is used
for data decoding. Write a value such as e-mail address with consent of the receiver who performs XML
decryption.
8-53
Chapter 8: SOAP Service Operation Commands
Notes
•
If this command is used to add or delete the setting for using the XML encryption, the Web Service
information edit tool or soapmodifydd command must be used to set whether XML is used for
encryption.
Examples
1.
To add/change settings for using the XML encryption.
>soapsecencconf -add -encid urn:sample1 -targeturi cid:file.jpg -keyalias
receiverkey
2.
To delete settings for using the XML encryption.
> soapsecencconf -del -encid urn:sample1
3.
To display a list of settings for using the XML encryption.
> soapsecencconf –list
ID=urn:sample1
ID= urn:sample2
ID= urn:sample3
4.
To display detailed settings for using the XML encryption.
> soapsecencconf -view -encid urn:sample1
ID=urn:sample1
uri=cid:file.jpg
8-54
soapsecdecconf
soapsecdecconf
Name
soapsecdecconf
Operation of setting for using XML decryption
Synopsis
(1) To add/change settings for using the XML decryption
soapsecdecconf -add [-f filename] -decid decid [-storefile filename]
[-storepass password] [-keyalias alias] [-keypass password]
[-keyname keyname]
(2) To delete settings for using the XML decryption
soapsecdecconf -del [-f filename] -decid decid
(3) To display a list of settings for using the XML decryption
soapsecdecconf -list [-f filename]
(4) To display detailed settings for using the XML decryption
soapsecdecconf -view [-f filename] -decid decid
(1) To add/change settings for using the XML decryption
soapsecdecconf -add [-M systemname] [-f filename] -decid decid
[-storefile filename] [-storepass password] [-keyalias alias]
[-keypass password] [-keyname keyname]
(2) To delete settings for using the XML decryption
soapsecdecconf -del [-M systemname] [-f filename] -decid decid
(3) To display a list of settings for using the XML decryption
soapsecdecconf -list [-M systemname] [-f filename]
(4) To display detailed settings for using the XML decryption
8-55
Chapter 8: SOAP Service Operation Commands
soapsecdecconf -view [-M systemname] [-f filename] -decid decid
Description
The soapsecdecconf command adds/changes and deletes setting for using the XML decryption and
displays a list of settings for using the XML encryption and detailed the settings.
-M systemname
Specify the target multi-system name.
If this option is omitted, the default system is specified as a target.
-add
Adds or changes settings specified in the -decid option for using the XML decryption.
If this option is omitted, the default system is specified as a target.
-del
Deletes settings specified in the -decid option for using the XML decryption.
Specify this option always as the first command option.
-list
Displays a list of settings stored in the setup file for using the XML decryption.
Specify this option always as the first command option.
-view
Displays details on settings specified in the -decid option for using the XML decryption.
Specify this option always as the first command option.
-f filename
Specify the name of a file to store settings for using the XML decryption.
If this option is omitted, the setting is stored in a file as follows:
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
/opt/FJSVsoap/conf/issoapsecconf.xml
−
When the default is specified in the -M option
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
8-56
When a system name other than the default is specified in the -M option
soapsecdecconf
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/conf/issoapsecconf.xml
-decid decid
Specify the identifier (Web Service identifier) of the setting for using the XML decryption that is the
addition/change, deletion, or details display target.
-storefile filename
Specify the name of the certificate management file storing the private-key used for using the XML
decryption.
If this option is omitted, a certificate management file created with the soapSetSecurity command is
used.
-storepass password
Specify a password to access the certificate management file specified in the -storefile option.
-keyalias alias
Specify an alias of the private-key used for using the XML decryption.
If this option is omitted in a client system environment or in a certificate environment that is configured
using an old version, XML code decryption is performed using the private key created with the
soapSetSecurity command. In other environments, XML code decryption is performed using the SSL
definition name specified with com.fujitsu.interstage.soapx.websec of config.properties.
-keypass password
Specify a password to decode the private-key specified in the -keyalias option.
-keyname keyname
Specify the name of the private-key to be used for using the XML decryption.
This option is used to determine a private-key to be used for the XML decryption. Write a value such as
e-mail address with consent of the sender of the encrypted data as key name.
Notes
•
If this command is used to add or delete setting for using the XML decryption, the Web Service
information edit tool or soapmodifydd command must be used to set whether the XML
encryption/decryption is to be used.
Examples
1.
To add/change settings for using the XML decryption.
> soapsecdecconf -add -decid urn:sample1 -keyalias mykey -keypass
chaingeit
8-57
Chapter 8: SOAP Service Operation Commands
2.
To delete settings for using the XML decryption.
> soapsecdecconf -del -decid urn:sample1
3.
To display a list of settings for using the XML decryption.
> soapsecdecconf –list
ID=urn:sample1
ID=urn:sample2
ID=urn:sample3
4.
To display detailed settings for using the XML decryption.
> soapsecdecconf -view -decid urn:sample1
ID=urn:sample1
Key alias=mykey
keypass=********
8-58
soapsecrelconf
soapsecrelconf
Name
soapsecrelconf
Setting operations with the reliable messaging function
Synopsis
(1) To add/change settings for the reliable messaging function
soapsecrelconf -add {message | from | to | local} [-f filename] [messageid id]
[-serviceid name] [-storedir dirname] [-partnerid id]
[-address url] [-listener listener] [-storefile filename]
[-storepass password] [-signalias alias] [-verifyalias alias]
[-keypass password] [-timeout time] [-retry num]
[-username username] [-password password]
(2) To delete settings for the reliable messaging function
soapsecrelconf
filename]
-del {message | from | to | local | service} [-f
[-messageid id] [-partnerid id] [serviceid id]
(3) To display a list of settings for the reliable messaging function
soapsecrelconf
messageid id]
-list {message | from | to | service} [-f filename] [-
(4) To display detailed settings for the reliable messaging function
soapsecrelconf
-view {message | from | to | local} [-f filename]
[-messageid id] [-partnerid id]
(1) To add/change settings for the reliable messaging function
soapsecrelconf -add {message | from | to | local} [-M systemname]
[-f filename] [-messageid id] [-serviceid name] [-storedir dirname]
[-partnerid id] [-address url] [-listener listener]
[-storefile filename] [-storepass password] [-signalias alias]
[-verifyalias alias] [-keypass password] [-timeout time]
[-retry num] [-timeout time] [-retry num] [-username username]
8-59
Chapter 8: SOAP Service Operation Commands
[-password password]
(2) To delete settings for the reliable messaging function
soapsecrelconf
systemname]
-del {message | from | to | local | service} [-M
[-f filename] [-messageid id] [-partnerid id] [serviceid
id]
(3) To display a list of settings for the reliable messaging function
soapsecrelconf -list {message | from | to | service} [-M systemname] [f filename]
[-messageid id]
(4) To display detailed settings for the reliable messaging function
soapsecrelconf -view {message | from | to | local} [-M systemname] [-f
filename]
[-messageid id] [-partnerid id]
Description
The soapsecrelconf command adds/changes and deletes settings for the reliable messaging function
and displays a list of settings for the reliable messaging function and detailed settings.
-M systemname
Specify the target multi-system name.
If this option is omitted, the default system is specified as a target.
-add {message | from | to | local}
•
When the message parameter is specified
This option adds/changes data set for the message type specified in the -messageid option.
8-60
•
When the from parameter is specified
This option adds/changes a sender client ID (PUSH model) or sender server ID (PULL model) that
is specified in the -partnerid option for the message type specified in the -messageid option. Use
the from parameter when a client or server with reliable messaging set receives the reliable
message with an application.
This parameter is invalid if a message type and sender ID are not specified in the -messageid
option and -partnerid option.
•
When the to parameter is specified
This option adds/changes a receiver server ID (PUSH model) or receiver client ID (PULL model)
that is specified in the -partnerid option for the message type specified in the -messageid option.
Use the to parameter when a client or server with reliable messaging set sends the reliable
message with an application.
This parameter is invalid if a message type and receiver ID are not specified in the -messageid
option and -partnerid option.
soapsecrelconf
•
When the local parameter is specified
This option adds/changes data for a client or server with reliable messaging set. The target is a
sender client (PUSH model) or receiver client (PULL model) for the reliable messaging client
function.
For the reliable messaging server function, the target is a receiver server (PUSH model) or sender
server (PULL model).
Only one local parameter can be specified in the same client or server.
Specify the -add option always as the first command option.
-del {message | from | to | local | service}
•
When the message parameter is specified
This option deletes data set for the message type specified in the -messageid option.
•
When the from parameter is specified
This option deletes a sender client ID (PUSH model) or sender server ID (PULL model) that is
specified in the -partnerid option for the message type specified in the -messageid option.
•
When the to parameter is specified
This option deletes a receiver server ID (PUSH model) or receiver client ID (PULL model) that is
specified in the -partnerid option for the message type specified in the -messageid option.
•
When the local parameter is specified
This option deletes data set for a client or server with reliable messaging set.
•
When the service parameter is specified
This option deletes all reliable messaging data items set with the service identifier specified in the
-serviceid option.
Specify the -del option always as the first command option.
-list {message | from | to | service}
•
When the message parameter is specified
This option displays a list of message types stored in the setup file.
•
When the from parameter is specified
This option displays a list of PUSH model sender client IDs or PULL model sender server IDs for
the message type specified in the -messageid option.
•
When the to parameter is specified
This option displays a list of PUSH model receiver server IDs or PULL model receiver client IDs for
the message type specified in the -messageid option.
•
When the service parameter is specified
This option display a list of service identifiers stored in the setup file.
Specify the -list option always as the first command option.
8-61
Chapter 8: SOAP Service Operation Commands
-view {message | from | to | local}
•
When the message parameter is specified
This option displays details on data set for the message type specified in the -messageid option.
•
When the from parameter is specified
This option displays details on data set for the PUSH model sender client or PULL model sender
server that is specified in the -partnerid option.
•
When the to parameter is specified
This option displays details on data set for the PUSH model receiver server or PULL model receiver
client that is specified in the -partnerid option.
•
When the local parameter is specified
This option displays details on data set for the client or server with reliable messaging set.
Specify the -view option always as the first command option.
-f filename
Specifies the name of a file to store data set with the reliable messaging function.
If this option is omitted, the data is stored as follows:
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
/opt/FJSVsoap/conf/issoapsecconf.xml
−
When the default is specified in the -M option.
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
When a system name other than the default is specified in the -M option
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/conf/issoapsecconf.xml
-messageid id
Specify an identifier to indicate a message type. The identifier must be unique in a machine.
-serviceid id
Specify a service identifier. This option must always be specified for changing data set from GUI.
-storedir dirname
Specify a directory to store messages.
If this option is omitted, messages are stored in the following directory:
8-62
soapsecrelconf
C:\Interstage\F3FMsoap\conf\issoapsecconf.xml
/opt/FJSVsoap/conf/issoapsecconf.xml
−
When the default is specified in the -M option.
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is not available
/opt/FJSVsoap/MI/{System_name}/conf/issoapsecconf.xml
−
When a system name other than the default is specified in the -M option
−
When the -M option is omitted and a system name other than the default is set in environment
variable IS_SYSTEM
/opt/FJSVsoap/etc/reliableMessage
-partnerid id
When -add {from | to}, -del {from | to}, or -view {from | to} is specified, specify a PUSH model receiver
server ID or PULL model sender server ID for the reliable messaging client function. For the reliable
messaging server function, specify a PUSH model sender client ID or PULL model receiver client ID.
When the -add option is specified with the local parameter, specify the ID of a client or server with
reliable messaging set. The ID to be specified is a PUSH model sender client ID or PULL model
receiver client ID for the reliable messaging client function. For the reliable messaging server function, it
is a PUSH model receiver server ID or PULL model sender server ID.
This option is always necessary to specify -add {from | to | local}, -del {from | to}, or -view {from | to}.
-address url
This option is valid when -add {from | to} is specified and reliable messaging is set with a PUSH model
sender client or PULL model receiver client. Specify the URL of the server supporting the reliable
messaging function.
When the -add option is specified with the from parameter and the -address option is specified, reliable
messaging is set with a PULL model receiver client. If the -address option is omitted, reliable
messaging is set with a PUSH model receiver server.
When the -add option is specified with the to parameter and the -address option is specified, reliable
messaging is set with a PUSH model sender client. If the -address option is omitted, reliable messaging
is set with a PULL model sender server.
-listener classname
This option is valid when the -add option is specified with the from parameter. Specify the class name of
a receiver application to be executed when a message is received from a PUSH model sender client or
PULL model sender server specified by -messageid and -partnerid. A class specified here must have
the OnewayListener interface installed. For details on OneWayListener, refer to the explanation of
messaging method application installation in the SOAP Service User's Guide.
This option must always be specified when the -add option is specified with the from parameter.
8-63
Chapter 8: SOAP Service Operation Commands
-storefile filename
This option is valid when the -add option is specified. Specify a private-key to be used for adding or
verifying a SOAP digital signature or the name of a certificate management file storing a site certificate.
When -add {from | to} is specified, specify the name of a certificate management file storing a site
certificate to be used for verifying a SOAP digital signature created by a message sender/receiver.
When the -add option is specified with the local parameter, specify the name of a certificate
management file storing a private-key to be used for adding a SOAP digital signature.
Specify this option when using the private key or certificate stored in a certificate management file that is
different from the one created with the soapSetSecurity command in a client system environment or in a
certificate environment that is configured using an old version. If this option is omitted in a client system
environment or in a certificate environment that is configured using an old version, the private key and
site certificate included in the certificate management file created with the soapSetSecurity command
are used to add or verify SOAP digital signatures.
In other environments, the private key and site certificate included in the certificate management file
created in the Interstage certificate environment are used to add or verify SOAP digital signatures.
-storepass password
This option is valid when -add is specified. Specify the password used to access the certificate control
file specified by -storefile.
-signalias alias
This option is valid when the -add option is specified with the local parameter.
Specify an alias of the private-key to be used for adding a SOAP digital signature.
Specify this option when the client or server for which reliable messaging is to be set uses a private key
that is different from the one prepared by the soapSetSecurity command in a client system environment
or in a certificate environment that is configured using an old version. If the -signalias option is specified,
the -storefile, -storepass, and -keypass options must be specified.
If this option is omitted in a client system environment or in a certificate environment that is configured
using an old version, the private key created with the soapSetSecurity command is used to add SOAP
digital signatures.
In other environments, the SSL definition name specified with com.fujitsu.interstage.soapx.websec of
config.properties is used to add SOAP digital signatures.
-verifyalias alias
This option is valid when -add {from | to} is specified.
Specify the alias of a site certificate to be used for verifying a SOAP digital signature created by a client
or server that is a destination of communication with reliable messaging set.
If this option is omitted when -add {from | to} is specified, the SOAP digital signature is not used (no
signature option) in communication using the reliable messaging function.
-keypass password
This option is valid when -add option is specified with the local parameter.
Specify a password to decrypt a private-key specified in the -signalias option.
8-64
soapsecrelconf
-timeout time
This option is valid when -add option is specified with the message parameter.
Specify a transmission time out time by combining a numeric value and unit for a message
corresponding to the message type specified in the -messageid option. Day (d), hour (h), minute (m),
and second (s) can be used as unit. Examples are shown below:
-timeout 10m: Ten minutes
-timeout 100s: 100 seconds
-retry number
This option is valid when -add option is specified with the message parameter.
Specify the maximum retransmission count for a message that cannot be sent due to an error or time
out. The specified value is valid for the message type specified in the -messageid option.
-username username
This option is valid for setting the reliable messaging client function and when -add {from | to} is
specified. Specify a user name for Basic authentication executed with the reliable messaging function.
-password password
This option is valid for setting the reliable messaging client function and when -add {from | to} is
specified. Specify a password for Basic authentication executed with the reliable messaging function.
Notes
•
When this command is used for adding or deleting a data set for server system reliable messaging,
the Web Service information edit tool or soapmodifydd command must also be used for adding or
deleting the corresponding data set with the reliable messaging function.
•
Identifiers specified in the -messageid and -partnerid options are used as the names of a directory
and file for storing messages with reliable messaging. Therefore, the characters used in the
identifiers should be usable to indicate directory and file names in the operating system. If an
identifier specified in these options cannot be recognized as a directory or file name in the
operating system, an error occurs in executing the reliable messaging function.
Examples
1.
A message type is added/changed with the reliable messaging function.
> soapsecrelconf -add message -messageid purchaseOrder -timeout 10m retry 5
2.
Data is set with the reliable messaging function for a client or server for which reliable messaging is
set.
> soapsecrelconf -add local -partnerid buyer
8-65
Chapter 8: SOAP Service Operation Commands
3.
Data for reliable messaging is set with the reliable messaging function (client function) for a
message receiver.
> soapsecrelconf -add to -messageid purchaseOrder -partnerid seller
-address http://seller.url/ -verifyalias selleralias
-serviceid PurchaseService
4.
Data for reliable messaging is set with the reliable messaging function (server function) for a
message sender.
>soapsecrelconf -add from -messageid purchaseOrder -partnerid buyer
-verifyalias buyeralias -lisner samples.SampleSellerListner
-serviceid PurchaseService
5.
A message type set with the reliable messaging function is deleted.
> soapsecrelconf -del message -messageid purchaseOrder
6.
Data set with the reliable messaging function for a message sender is deleted.
> soapsecrelconf -del from -messageid purchaseOrder -partnerid buyer
7.
Data set with the reliable messaging function for a message receiver is deleted.
> soapsecrelconf -del to -messageid purchaseOrder -partnerid seller
8.
Data set with the reliable messaging function for a service is deleted.
> soapsecrelconf -del service -serviceid urn:OrderService
9.
Data set with the reliable messaging function for a client or server for which reliable messaging is
set is deleted.
> soapsecrelconf -del local
10. A list of message types set with the reliable messaging function is displayed.
> soapsecrelconf -list message
11. A list of message senders set with the reliable messaging function is displayed.
> soapsecrelconf -list from -messageid purchaseOrder
From Party ID=buyer1
From Party ID=buyer2
12. A list of message receivers set with the reliable messaging function is displayed.
> soapsecrelconf -list to -messageid purchaseOrder
To Party ID=seller1
To Party ID=seller2
8-66
soapsecrelconf
13. A list of service items set with the reliable messaging function is displayed.
> soapsecrelconf -list service
Message ID=purchaseOrder
From service=buyerService
Message ID=paymentOrder
To service=sellerService
14. Details on a message type set with the reliable messaging function are displayed.
> soapsecrelconf -view message -messageid purchaseOrder
Message ID=purchaseOrder
From partyId=buyer
From listenerClass=samples.reliable.SampleMediator
From address=null
From getServiceName=buyerService
From sigalias=buyer
From username=null
From password=null
MessageStoreFactory
StoreParameter name=directory
StoreParameter value=./mediator_furikomi
15. Details on data set with the reliable messaging function for a message sender are displayed.
> soapsecrelconf -view from -messageid purchaseOrder -partnerid buyer
Message ID=purchaseOrder
From partyId=buyer
From listenerClass=samples.reliable.SampleMediator
From address=null
From getServiceName=buyerService
From sigalias=buyer
From username=null
From password=null
MessageStoreFactory
StoreParameter name=directory
StoreParameter value=./mediator_furikomi
16. Details on data set with the reliable messaging function for a message receiver are displayed.
> soapsecrelconf -view to -messageid purchaseOrder -partnerid seller
To partyId=seller
To address=null
To getServiceName=sellerService
To sigalias=seller
To username=null
To password=null
8-67
Chapter 8: SOAP Service Operation Commands
17. Details on data set with the reliable messaging function for a client or server for which reliable
messaging is set are displayed.
> soapsecrelconf -view local
Local partyId=mediator
Local sigalias=mediator
8-68
soapcldeploy
soapcldeploy
Name
soapsecverifyconf
Display and editing of Web Service information (for client system)
Synopsis
soapcldeploy
Description
The soapcldeploy command displays/edits Web Service information about a client application that
operates in a client system.
8-69
Chapter 8: SOAP Service Operation Commands
8-70
Part 4
Web Server Operation Edition
Chapter 9
Interstage HTTP Server Operation
Commands
This chapter describes the Interstage HTTP Server operation commands.
Note
The Interstage HTTP Server operation commands can be used in the following products.
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition
9-1
Chapter 9: Interstage HTTP Server Operation Commands
apachectl
Name
apachectl
Starting and stopping the Interstage HTTP Server
Synopsis
apachechl
start | stop
Description
This command starts and stops the Interstage HTTP Server.
The available options are shown below:
start
Starts the Interstage HTTP Server.
stop
Stops the Interstage HTTP Server.
Notes
9-2
•
Execute this command with administrator authority.
•
Except "start" and "stop," the options that can be used in Apache 1.3.22 (original version) cannot be
used in the Interstage HTTP Server.
•
This apachectl stop command can only stop an Interstage HTTP Server that was started up using
the corresponding start command (apachectl start).
If the Interstage management console is used to start the Interstage HTTP Server, be sure to use
the Interstage management console to stop it. Similarly, if an Interstage integrated command
(isstart) is used to start the Interstage HTTP Server ("FJapache execute" is displayed when the
isstat command is issued to check the Interstage HTTP Server activation status), be sure to use an
Interstage integrated command (isstop) to stop it.
•
The Interstage integration command to start up and stop the Interstage HTTP Server is available in
the following products:
−
Interstage Application Server Enterprise Edition
−
Interstage Application Server Standard Edition.
apachectl
Examples
Starts the Interstage HTTP Server.
apachectl start
Stops the Interstage HTTP Server.
apachectl stop
9-3
Chapter 9: Interstage HTTP Server Operation Commands
htpasswd
Name
htpasswd
Enables the editing of password files for user authentication.
Synopsis
htpasswd [-c] passwdfile username
Description
This command enables you to edit the password file that is used for user authentication.
This command is used to specify the AuthUserFile directive parameter in the environment definition file
(httpd.conf).
The available options and parameters are shown below:
-c
Creates a new user password file. If there is another file with the same name, it is overwritten. If this
option is omitted, the user name is added to the file specified with passwdfile.
passwdfile
Specify a password file name.
username
Specify a user name to be added.
Notes
To delete a user, edit the password file by using a text editor.
The contents of the password file appear as follows when it is referenced using a text editor. To delete
"user2," delete the line containing "user2" and save the file.
user1:$apr1$SR3.....$4aQAE2EU9NZTtbkxMEOa4/
user2:$apr1$DS3.....$tEb4EYLhraAc1p2wIygTV/
9-4
htpasswd
Examples
To create a new password file "C:\Interstage\F3FMihs\conf\password.txt," and register the password of
user "user1":
htpasswd -c C:\Interstage\F3FMihs\conf\password.txt user1
New password:*****
Re-type new password:*****
Adding password for user user1
To add the password of user "user2" to the same password file as above:
htpasswd C:\Interstage\F3FMihs\conf\password.txt user2
New password:*****
Re-type new password:*****
Adding password for user user2
To create a new password file "/opt/FJSVihs/conf/password.txt", and register the password of user
"user1":
htpasswd -c /opt/FJSVihs/conf/password.txt user1
New password:*****
Re-type new password:*****
Adding password for user user1
To add the password of user "user2" to the same password file as above:
htpasswd /opt/FJSVihs/conf/password.txt user2
New password:*****
Re-type new password:*****
Adding password for user user2
9-5
Chapter 9: Interstage HTTP Server Operation Commands
ihsrlog
Name
ihsrlog
Log file rotation
Synopsis
(1) Rotating through log files in units of file sizes
ihsrlog -s logfile size count
(2) Rotating through log files in units of days
ihsrlog -d logfile time count
Description
This command specifies whether a log file to which access log or error log information is output is
created in units of file size or units of days.
This command is used to specify the ErrorLog directive parameter, CustomLog directive parameter, and
TransferLog directive parameter in the environment definition file (httpd.conf).
The available options and parameters are shown below:
-s
Rotates through log files in units of file sizes.
-d
Rotates through log files in units of days.
logfile
Specifies the directory where the log file is stored and the prefix for the log file name.
The directory must be specified with the relative path from the installation directory of Interstage
HTTP Server.
The directory must be specified with the absolute path.
9-6
ihsrlog
The format of the output file name is "file-name-prefix.YYMMDDhhmmss.N." "YYMMDDhhmmss"
indicates the date and time when the file was created. ".N" indicates the log file serial number.
•
YY: Year (02 represents the year 2002.)
•
MM: Month (1 to 12)
•
DD: Date (1 to 31)
•
hh: Hour (0 to 23)
•
mm: Minute (0 to 59)
•
ss: Second (0 to 59)
•
[.N]: Log file serial number (when -s option is specified)
The log file serial number is added to the second and later files when more than one
"YYMMDDhhmmss" file exists. (To the nth file, "(.n-1)" is added.)
size
This option specifies the maximum size of one log file in megabytes from 1 to 999999. The option is
valid only when the -s option is specified.
time
This option specifies the number of days for the rotation interval from 1 to 365. The option is valid only
when the -d option is specified.
count
The option specifies the maximum number of files from 0 to 999.
A new file is created in either of the following cases, depending on the option specified. If the allowed
maximum number of files is reached, the oldest log file is deleted and a new log file is created.
•
Specifying the -s option
When the size of the file exceeds the specified limit
•
Specifying the -d option
When the number of the days that have passed since the file creation date exceeds the specified
limit
The upper limit number of set files, however, is only valid from the startup of the Interstage HTTP Server
to the time the Interstage HTTP Server is stopped. When the server is restarted, the log file created
during the previous operation is not deleted. Therefore, delete it if it is not needed.
9-7
Chapter 9: Interstage HTTP Server Operation Commands
Examples
When an access file (specified in megabytes; maximum number of files: 5) is output to the file
"C:\Interstage\F3FMihs\logs\accesslog.xxxxxxxxxxxx[.x]" (Installation path is used by default):
ihsrlog -s logs/accesslog 1 5
When the access log is output while setting the environment definition file according to the above
example:
CustomLog "|ihsrlog -s logs/accesslog 1 5" common
When an access file (specified in days; maximum number of files: 5) is output to the file
"C:\Interstage\F3FMihs\logs\accesslog.xxxxxxxxxxxx":
ihsrlog -d logs/accesslog 1 5
When the access log is output while setting the environment definition file according to the above
example:
CustomLog "|ihsrlog -d logs/accesslog 1 5" common
When an access file (specified in megabytes; maximum number of files: 5) is output to the file
"/opt/FJSVihs/logs/accesslog.xxxxxxxxxxxx[.x]" (Installation path is used by default):
ihsrlog -s /opt/FJSVihs/logs/accesslog 1 5
When the access log is output while setting the environment definition file according to the above
example:
CustomLog "|/opt/FJSVihs/bin/ihsrlog -s /opt/FJSVihs/logs/accesslog 1 5"
common
When an access file (specified in days; maximum number of files: 5) is output to the file
"/opt/FJSVihs/logs/accesslog.xxxxxxxxxxxx":
ihsrlog -d /opt/FJSVihs/logs/accesslog 1 5
When the access log is output while setting the environment definition file according to the above
example:
CustomLog "|/opt/FJSVihs/bin/ihsrlog -d /opt/FJSVihs/logs/accesslog 1 5"
common
9-8
Chapter 10
InfoProvider Pro Operation Commands
This chapter describes the InfoProvider Pro operating commands. These commands are stored in the
following directory:
C:\Interstage\F3FMwww\Program
/opt/FSUNprovd/bin
The operation commands must be stored under the directory specified in installdir of the InfoProvider
Pro environment definition file.
Start the operation commands by the relative path or the full path from the current directory. The
operation commands cannot be started normally even if the directory for storing the operation
commands is specified in the PATH of the environment variable.
Notes
The InfoProvider Pro operation command can be used with the following products of the Windows(R)
system or Solaris OE system:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition.
10-1
Chapter 10: InfoProvider Pro Operation Commands
If the Solaris OE system is used, only the following commands can be used:
10-2
•
ippadpasswd
•
ippdisp
•
ipprestart
•
ippstart
•
ippstop
ippadpasswd
ippadpasswd
Name
ippadpasswd
Specifies the password management file.
Synopsis
(1) Register a user:
ippadpasswd –f uidfile –a usrid –p password
(2) Delete a user:
ippadpasswd –f uidfile –d usrid
(3) Change a user password:
ippadpasswd –f uidfile –u usrid –p password –op old-password
Description
The ippadpasswd command specifies the password management file.
The password file manages user names and passwords. The password management file is used to
verify users. The ippadpasswd command registers users in the password management file, deletes
users and changes user passwords.
The options and arguments of the ippadpasswd command are as follows:
-f uidfile
Specifies the full path name of the password management file that manages user names and passwords.
-a usrid
Specifies a user registered in the password management file.
-d usrid
Specifies a user to be deleted from the password management file.
-u usrid
Specifies a user whose password is to be changed.
10-3
Chapter 10: InfoProvider Pro Operation Commands
-p password
Specifies a password. Specify the new password when changing a password.
-op old-password
Specifies an old password.
Notes
•
Execute this command with administrator authority.
•
Specify the user name and password in up to 64 bytes of one byte ASCI alphanumeric character
string (0 – 9, A – Z and a – z).
Examples
(1) Registering a user:
ippadpasswd –f c:\PROGRA~1\INTERS~1\F3FmwwwSecurity\passwd.dat –a usr001
–p usr001p
(2) Deleting a user:
ippadpasswd –f c:\PROGRA~1\INTERS~1\F3FmwwwSecurity\passwd.dat –d usr001
(3) Changing a user password:
ippadpasswd –f c:\PROGRA~1\INTERS~1\F3FmwwwSecurity\passwd.dat –u usr001
–p USR001 –op usr001p
(1) Registering a user:
ippadpasswd -f /etc/opt/FSUNprovd/passwd.conf -a usr001 -p usr001p
(2) Deleting a user:
ippadpasswd -f /etc/opt/FSUNprovd/passwd.conf -d usr001
(3) Changing a user password:
ippadpasswd -f /etc/opt/FSUNprovd/passwd.conf -u usr001 -p USR001 -op
usr001p
10-4
ippdisp
ippdisp
Name
ippdisp
Show the start status of InfoProvider Pro
Synopsis
ippdisp –f config_file
ippdisp [–f config_file]
Description
The ippdisp command displays the start status of the InfoProvider Pro. Table 10-1 details the
information displayed.
Table 10-1 Details Displayed by the ippdisp Command
Title
Description
ippstat
Displays the start status of the InfoProvider Pro:
running Running
stopping Stopping
starting Starting
restarting Restarting
config-file
Displays the InfoProvider Pro environment definition file.
stime
Displays the time and date that InfoProvider Pro was started or restarted.
ip-address
Displays the InfoProvider Pro IP address.
ip-version
Displays the InfoProvider Pro IP version.
port
Displays the InfoProvider Pro port number.
pid
Displays the process ID for the InfoProvider Pro process.
comment
Displays characters strings specified by comment in the InfoProvider Pro
environment definition file.
10-5
Chapter 10: InfoProvider Pro Operation Commands
Title
Description
secure mode
Displays the InfoProvider Pro operation mode.
- ON :When operating in security mode.
- OFF:When operating in normal mode.
sessuser
Displays the total number of users logged on to InfoProvider Pro session
management.
Gateway ID
Displays the number of users logged on to each gateway.
active request
Displays the processing thread operation state of InfoProvider Pro.
It is displayed in the form of XX/YY.
XX is the number of threads under processing now.
YY is the simultaneous access maximum number specified by the concurrency
item.
pooling request
Displays the demand receptionist pool state of InfoProvider Pro.
It is displayed in the form of XX/YY.
XX is the number of requests under pooling now.
YY is the maximum pooling count specified by the pool-max item.
operation_log
Displays the results of starting, stopping and restarting the InfoProvider Pro.
accesslog
Displays the name of the access log file that the InfoProvider Pro identifies as
the current output target by the full path.
If it has been defined that the access log is not collected in the InfoProvider Pro
environment definition file, the file name is not displayed.
errorlog
Displays the name of the error log file that InfoProvider Pro identifies as the
current output target by the full path.
When -s parameter is specified, information is also displayed about the following items.
10-6
Title
Description
logformat
Displays the contents specified by the item "logformat" of an environment
definition file.
acslog-all
Displays the contents specified by the item "acslog-all" of an environment
definition file.
acslog-proctime
Displays the contents specified by the item "acslog-proctime" of an environment
definition file.
acslog-cookie
Displays the contents specified by the item "acslog-cookie" of an environment
definition file.
acslog-jsformat
Displays the contents specified by the item "acslog-jsformat" of an environment
definition file.
log-erraction
Displays the contents specified by the item "log-erraction" of an environment
definition file.
errlog-format
Displays the contents specified by the item "errlog-format" of an environment
ippdisp
Title
Description
definition file.
timeout-kill
Displays the contents specified by the item "timeout-kill" of an environment
definition file.
connection-limit
Displays the contents specified by the item "connection-limit" of an environment
definition file.
http-ver
Displays the contents specified by the item "http-ver" of an environment
definition file.
acceptancerequest-size
Displays the contents specified by the item "acceptance-request-size" of an
environment definition file.
dns-resolve
Displays the contents specified by the item "dns-resolve" of an environment
definition file.
falsificationthreshold
Displays the contents specified by the item "falsification-threshold" of an
environment definition file.
falsification-term
Displays the contents specified by the item "falsification-term" of an environment
definition file.
reqsize-threshold
Displays the contents specified by the item "reqsize-threshold" of an
environment definition file.
reqsize-term
Displays the contents specified by the item "reqsize-term" of an environment
definition file.
authfile
Displays the contents specified by the item "authfile" of an environment
definition file.
auth-target-url
Displays the contents specified by the item "auth-target-url" of an environment
definition file.
sslfile
Displays the contents specified by the item "sslfile" of an environment definition
file.
DirServFile
Displays the contents specified by the item "DirServFile" of an environment
definition file.
dirservlog
Displays a full path in the directory server use situation log file name that
InfoProvider Pro is considering as the candidate for the present output. A file
name is not displayed when the definition does not extract a directory server use
situation log for the InfoProvider Pro environment definition file being carried out.
server-header
Displays the contents specified by the item "server-header" of an environment
definition file.
server-name
Displays the contents specified by the item "server-name" of an environment
definition file.
The options and arguments of the ippdisp command are as follows:
10-7
Chapter 10: InfoProvider Pro Operation Commands
-f config_file
Specify only the file name of the environment definition file that started the InfoProvider Pro to be
displayed. The environment definition file is located in the following directory:
C:\Interstage\F3FMwww\Conf
Specify the environment definition file (that activated InfoProvider Pro whose status is to be displayed)
using the full path or relative path. When multiple InfoProvider Pro applications are activated by the
environment definition file specified in this option, the operating statuses of all InfoProvider Pro
applications activated by the environment definition file are also displayed.
If omitted, the operating statuses of all InfoProvider Pro applications are displayed.
-s
The security state of InfoProvider Pro is displayed.
Note
•
Execute this command with administrator authority.
Example of use
When specifying and displaying a C:\Interstage\F3FMwww\Conf subordinate's F3FMwww.dat file,
specify as follows.
[When a
ippdisp
[When a
ippdisp
security state is not displayed]
-f F3FMwww.dat
security state is displayed]
-f F3FMwww.dat -s
When specifying and displaying a /opt/FSUNprovd/conf subordinate's HTTPD.conf file, specify as
follows.
[When a
ippdisp
[When a
ippdisp
10-8
security state is not displayed]
-f /opt/FSUNprovd/conf/HTTPD.conf
security state is displayed]
-f /opt/FSUNprovd/conf/HTTPD.conf -s
ippdisp
Example of a display
The example of a display (in the case of a Solaris OE system) is shown below.
ippstat = running
config-file = /opt/FSUNprovd/conf/HTTPD.conf
stime = Wed Apr 3 16:35:08 2002
ip-address = xxx.xxx.xxx.xxx
ip-version = v4
port = 80
pid = 9006
secure mode = OFF
comment = Fujitsu home page
sessuser = 0
gai-gw = 0
active request = 0 / 40
pooling request = 0 / 200
operation_log = Fri Dec 19 10:27:14 1998 Start processing completed
accesslog = /var/opt/FSUNprovd/acslog
errorlog = /var/opt/FSUNprovd/errlog
In addition to the above, the following information is displayed when "-s" is specified as a parameter.
logformat = standard
acslog-all = ON
acslog-proctime = ON
acslog-cookie = OFF
acslog-jsformat = common
log-erraction = CONTINUE
errlog-format = expand
timeout-kill = OFF
connection-limit = 0
http-ver = 11
acceptance-request-size = 696320
dns-resolve = ON
falsification-threshold = 10
falsification-term =
reqsize-threshold = 10
reqsize-term =
authfile = /etc/opt/FSUNprovd/http_auth
auth-target-url = mapped
sslfile = /etc/opt/FSUNprovd/samp_ssl_psctl.conf
DirServFile = /etc/opt/FSUNprovd/DirServFile
dirservlog = /var/opt/FSUNprovd/dirservlog_xxx.xxx.xxx.xxx_xx
server-header = none
server-name =
10-9
Chapter 10: InfoProvider Pro Operation Commands
ipprestart
Name
ipprestart
Restarts InfoProvider Pro
Synopsis
ipprestart –f config_file [-m {normal | immediate | security} ]
ipprestart[-f config_file][-m {normal | immediate | security} ]
Description
The ipprestart command restarts the InfoProvider Pro.
The InfoProvider Pro is restarted when the contents of the environment definition file, the security
management file specified in the environment definition file, or the gateway environment definition files
are changed while the InfoProvider Pro is operating. Restarting minimizes the interruption to operations.
The options and arguments of the ipprestart command are as follows:
-f config_file
Specify only the file name of the environment definition file that started the InfoProvider Pro to be
restarted. The environment definition file is located in the following directory:
C:\Interstage\F3FMwww\Conf
Specify the environment definition file (that started InfoProvider Pro) to be restarted by using the full path
or relative path.
If omitted, all InfoProvider Pro applications are restarted.
10-10
ipprestart
-m normal|immediate|security
•
normal (Abbreviation value)
Suspends acceptance of logons to applications using session management after the command is
received, waits for all users logged on to log off, and then restarts the InfoProvider Pro
•
immediate
Suspends acceptance of logons to applications using session management after the command is
received, instructs all processes corresponding to users logged on to log off, and then restarts the
InfoProvider Pro
•
security
Copies verification specified definition information to Web Server. Copies all security management
files and file information specified in security management files.
Changes security information even if users are logged on to applications that use session
management.
•
Execute this command with administrator authority.
•
The following environment elements cannot be changed by restarting:
Notes
−
•
IP address at startup (IP-address)
−
Port number at startup
−
Installation directory of environment definition file for InfoProvider Pro (installdir)
−
Maximum number of simultaneous accesses to InfoProvider Pro environment definition file
(concurrency)
−
Maximum number of pooling to InfoProvider Pro environment definition file (pool-max)
The following environment elements cannot be changed by restarting:
−
IP address at startup (IP-address)
−
Port number at startup
−
Installation directory of environment definition file for InfoProvider Pro (installdir)
−
Maximum number of simultaneous accesses to InfoProvider Pro environment definition file
(concurrency)
−
Maximum number of pooling to InfoProvider Pro environment definition file (pool-max)
−
The code system (output-code) transmitted to the Web browser specified in the InfoProvider
Pro environment definition file when the code system to be returned is specified by the –oc
option at startup.
−
The user name and group name authority (uid, gid) when CGI is started.
10-11
Chapter 10: InfoProvider Pro Operation Commands
Example
When specifying and rebooting a C:\Interstage\F3 FMwww\Conf subordinate's F3FMwww.dat file,
specify as follows.
ipprestart -f F3FMwww.dat
10-12
ippsetstartup
ippsetstartup
Name
ippsetstartup
Specifies automatic startup of InfoProvider Pro
Synopsis
(1) Register environment definition file to be started automatically:
ippsetstartup –a config_file
(2) Delete environment definition file to be started automatically:
ippsetstartup –d config_file
(3) Display list of environment definition files registered for automatic start:
ippsetstartup -p
Description
The ippsetstartup command specifies automatic start for the InfoProvider Pro.
This command registers and deletes automatic startup for the specified InfoProvider Pro environment
definition files. It also lists environment definition files registered for automatic startup.
The options and arguments of the ippsetstartup command are as follows:
-a config_file
Specify only the environment definition file registered for automatic startup. The environment definition
file is located in the following directory:
C:\Interstage\F3FMwww\Conf
-d config_file
Specify only the environment definition file to be deleted from automatic startup. The environment
definition file is located in the following directory:
C:\Interstage\F3FMwww\Conf
-p
Displays a list of environment definition files registered for automatic startup
10-13
Chapter 10: InfoProvider Pro Operation Commands
Notes
•
Execute this command with administrator authority.
•
The ippsetstartup command does not check whether the identical port number has been specified.
Ensure that an environment definition file with an identical port number is registered.
•
Settings registered or deleted with the ippsetstartup command become effective again the next time
the operating system or service is started.
Example
When specifying and registering a C:\Interstage\F3 FMwww\Conf subordinate's F3FMwww.dat file,
specify as follows.
ippsetstartup –a F3FMwww.dat
10-14
ippstart
ippstart
Name
ippstart
Starts InfoProvider Pro
Synopsis
ippstart –f config_file
(1) Starting InfoProvider Pro:
ippstart [-f config-file][-p port-number][-oc code-type]
(2) Displaying InfoProvider Pro copyright:
ippstart -v
Description
The ippstart command starts the InfoProvider Pro. This command starts the InfoProvider Pro according
to the settings in the environment definition file.
The options and arguments of the ippstart command are as follows:
-f config_file
Specify only the environment definition file name. The environment definition file is located in the
following directory:
C:\Interstage\F3FMwww\Conf
Specify the environment definition file name using the full path or relative path.
If omitted, HTTPD.conf of the current directory is used as the environment definition file.
10-15
Chapter 10: InfoProvider Pro Operation Commands
-p port-number
Specify the port number to use.
If omitted, InfoProvider Pro is started up using the port number specified by the environment definition
file.
-oc code-type
Specify the code system of HTML to be returned.
If omitted, the code system is defined by "output-code" of the environment definition file.
-v
Copyright display of InfoProvider Pro. InfoProvider Pro is not started up.
Notes
•
Execute this command with administrator authority.
•
Do not change the port number in the environment definition file after the InfoProvider Pro has
been started. The InfoProvider Pro may not stop correctly, and the InfoProvider Pro start status
may not be displayed correctly.
Example
When specifying and starting a C:\Interstage\F3 FMwww\Conf subordinate's F3FMwww.dat file, specify
as follows.
ippstart –f F3FMwww.dat
10-16
ippstartsv
ippstartsv
Name
ippstartsv
Starts InfoProvider Pro Service
Synopsis
ippstartsv
Description
The ippstartsv command starts the InfoProvider Pro Service
Note
•
Execute this command with administrator authority.
10-17
Chapter 10: InfoProvider Pro Operation Commands
ippstop
Name
ippstop
Stops InfoProvider Pro.
Synopsis
ippstop –f config_file [-m {normal | immediate} ]
ippstop [-f config-file][-m {normal | immediate} ]
Description
The ippstop command stops the InfoProvider Pro.
The options and arguments of the ippstart command are as follows:
-f config_file
Specify only the environment definition file name that started the InfoProvider Pro to be stopped. The
environment definition file is located in the following directory:
C:\Interstage\F3FMwww\Conf
Specify the environment definition file name using the relative path or full path used to start up
InfoProvider Pro (to be shut down).
If omitted, all InfoProvider Pro applications that have been started are shut down.
-m normal|immediate
Specify either of the following stop modes:
10-18
•
normal (Abbreviation value)
Suspends acceptance of logons to applications using session management after the command is
received, waits for all users logged on to log off, and then stops the InfoProvider Pro
•
immediate
Suspends acceptance of logons to applications using session management after the command is
received, instructs all processes corresponding to users logged on to log off, and then stops the
InfoProvider Pro
ippstop
Notes
•
Execute this command with administrator authority.
•
InfoProvider Pro is stopped even if users are using the client ID notification WebGateway link.
•
When using InfoProvider Pro ("InfoProvider Pro=yes") and operation status monitoring mode ("IS
Monitor Mode=mode1") is set in the Interstage operating environment definition, (for Interstage
Application Server Enterprise Edition, Standard Edition or Plus), the InfoProvider Pro cannot be
stopped using this command. For details of the Interstage operating environment definition, refer to
the Operator's Guide.
Example
When specifying a C:\Interstage\F3 FMwww\Conf subordinate's F3FMwww.dat file and stopping, specify
as follows:
ippstop –f F3FMwww.dat
10-19
Chapter 10: InfoProvider Pro Operation Commands
ippstopsv
Name
ippstopsv
Stops InfoProvider Pro Service.
Synopsis
ippstopsv
Description
The ippstartsv command stops the InfoProvider Pro Service.
Notes
10-20
•
Execute this command with administrator authority.
•
When using InfoProvider Pro ("InfoProvider Pro=yes") and operation status monitoring mode ("IS
Monitor Mode=mode1") is set in the Interstage operating environment definition, (for Interstage
Application Server Enterprise Edition, Standard Edition or Plus), the InfoProvider Pro cannot be
stopped using this command. For details of the Interstage operating environment definition, refer to
the Operator's Guide.
Chapter 11
SSL Operation Commands
This chapter details the SSL operation commands.
Notes
The SSL command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition.
The following commands can be used only by the Windows (R) system and the Solaris OE system.
•
ippregistupin
•
mkslt
•
mktkn
The following commands can be used only by the Solaris OE system and the Linux system.
•
odsetpath
11-1
Chapter 11: SSL Operation Commands
SSL Environment Setting Commands
cmdspcert
Name
cmdspcert
Outputs a certificate.
Synopsis
cmdspcert [-ed Environment-directory ] {-id CertID | -nn NickName | -fn
FileName }
[-sl Select] [-of OutFile]
Description
The cmdspcert command outputs the contents of a certificate to edit, standard output, or a file for every
item.
The options and arguments of this command are as follows:
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-id CertID
Only when displaying a registered certificate, the certificate discernment name (CertID) displayed by the
cmlistcert command is specified.
-nn NickName
Only when displaying a registered certificate, the nickname (NickName) specified at the time of
registration is specified.
-fn FileName
A certificate file name (FileName) is specified only when displaying a non-registered certificate.
The file of DER form and BASE64 form can be specified.
-sl Select
Display form (Select) is specified.
0 : Display for every item (default)
1 : Display of a key
-of OutFile
The file name (OutFile) that outputs a display result is specified with a full path.
11-2
SSL Environment Setting Commands
If it omits, it will output to standard output. The file specifies an intact thing.
Remarks
•
It is necessary to specify -id, -nn, or -fn.
•
When a certificate of the BASE64 format is specified in the certificate file and the header and footer
listed below are described, these lines are skipped. If the header or footer has a format other than
the ones listed below, an abnormal end occurs. When the specified certificate file contains more
than one certificate, only the first certificate is processed.
−
Header: Line that begins with "-----BEGIN"
−
Footer: Line that begins with "-----END"
The item to which discernment name information is not set is not displayed.
cmentcert
Name
cmentcert
Registers a certificate.
Synopsis
cmentcert FileName [-ed Environment-directory ] [-nv] {-ca|-own} [-nn
NickName]
Description
The cmentcert command registers a certificate in a Certificate/Key Management Environment.
The options and arguments of this command are as follows:
FileName
Specify the full path to the file to be registered.
A file of the DER format or BASE64 format can be specified.
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-nv
Specify this parameter to not verify a certificate at registration.
-ca
Specify this parameter when the certificate issued by the Certification Authority (CA) is to be registered.
-own
Specify this parameter when the certificate issued to you is to be registered.
11-3
Chapter 11: SSL Operation Commands
-nn NickName
Specify a nickname (NickName). The nickname cannot begin or end with a blank character.
Remarks
•
A Certificate must be sequentially registered in the order from the "root" CA certificate.
•
When a certificate of the BASE64 format is specified in the certificate file and the header and footer
listed below are described, these lines are skipped. If the header or footer has a format other than
the ones listed below, an abnormal end occurs. When the specified certificate file contains more
than one certificate, only the first certificate is processed.
•
−
Header: Line that begins with "-----BEGIN"
−
Footer: Line that begins with "-----END"
Be sure to specify the -ca option or -own option. Since it is registered as another certificate when it
omits, it does not become effective in a Web server.
cmentcrl
Name
cmentcrl
Registers a CRL.
Synopsis
cmentcrl FileName [-ed Environment-directory ] [-nv]
Description
The cmentcrl command registers a CRL in a Certificate/Key Management Environment.
The options and arguments of this command are as follows:
FileName
Specify the full path to the file to be registered.
A file of the DER format or BASE64 format can be specified.
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-nv
Specify this parameter to not verify a CRL at registration.
Remarks
11-4
•
Old CRL is deleted when old CRL, published by the same CA, exists in the case of CRL registration.
•
You must register the certificate of CA, which is the publisher of CRL that registers beforehand.
SSL Environment Setting Commands
•
When a CRL of the BASE64 format is specified in the CRL file and the header and footer listed
below are described, these lines are skipped. If the header or footer has a format other than the
ones listed below, an abnormal end occurs. When the specified CRL file contains more than one
CRL, only the first CRL is processed.
−
Header: Line that begins with "-----BEGIN"
−
Footer: Line that begins with "-----END"
cmenterkey
Name
cmenterkey
Registers a private key.
Synopsis
cmenterkey
-ed Env-Dir -tl TokenLabel -kf KeyFile -kl KeyLabel
[-userpassword User-PIN -keypassword Key-Password]
Description
The cmenterkey command registers, in a token, the PKCS#8-formatted private-key file that was created
with the certificate creation tool appended to the InfoCA or InfoProvider Pro. That is, the PKCS#8formatted private-key file that was specified in the token that corresponds to the specified token label is
registered.
The encryption algorithm used in the PKCS#8-formatted private key must be DES.
The options and arguments of this command are as follows:
-ed Env-Dir
Specify the full path to the Certificate/Key Management Environment (Env-dir). This parameter cannot
be omitted.
-tl TokenLabel
Specify the token label (TokenLabel) in which a private key is to be registered. This parameter cannot
be omitted.
-kf KeyFile
Specify the full path to the PKCS#8-formatted private-key file (KeyFile). This parameter cannot be
omitted.
-kl KeyLabel
Specify the key label (KeyLabel) to be added to a registered token object. This parameter cannot be
omitted. The key label must be a number from 1 to 64.
-userpassword User-PIN
Specify the user PIN (UserPIN) for accessing the token. Blank characters cannot be specified. A
prompt for requesting the User-PIN input is not displayed.
11-5
Chapter 11: SSL Operation Commands
This parameter is not displayed in the Usage field of the command.
-keypassword Key-Password
Specify the password for decoding the private key. Blank characters cannot be specified. A prompt for
requesting password input is not displayed.
This parameter is not displayed in the Usage field of the command.
cmentpfx
Name
cmentpfx
Registers a certificate from PKCS#12(PFX) data.
Synopsis
cmentpfx FileName [-ed Environment-directory ] {-sn slotID|-tl TokenLabel}
[-kl KeyLabel] -nn NickName [-entca] [-sncert]
[-userPIN UserPIN -password Password]
Description
The certificate and private key stored in the PKCS#12(PFX) format data file are registered in the
certificate/private-key environment.
The input of the UserPIN and the password which decrypts PKCS#12(PFX) data, is performed
interactively.
The options and arguments of this command are as follows:
FileName
Specify the full path to the file that contains the PKCS#12(PFX) data.
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-sn slotID
Specify the slotID for registering a private key.
-tl TokenLabel
Specify the TokenLabel set in the token for registering a private key.
-kl KeyLabel
Specify the ASCII character string that indicates the label to be assigned to the private key to be
registered. When this parameter is omitted, the private key is registered without a label.
-nn NickName
Specify a nick name (NickName). A blank character cannot be specified at the beginning or end of the
character string.
11-6
SSL Environment Setting Commands
-entca
CA certificate is contained in PKCS#12(PFX) data, and CA certificate is registered when it has not been
registered into a Certificate/Key Management Environment.
-sncert
It specifies when registering an EE certificate into the same token as a private key. If it omits, it will
register with the Certificate/Key Management Environment.
-userPIN UserPIN
Specify the user PIN (UserPIN) for accessing the token. A blank character cannot be specified in this
parameter. A prompt for requesting the UserPIN input is not displayed.
This parameter is not displayed in the command Usage area.
-password Password
Specify the password for decoding the PKCS#12(PFX) data. A blank character cannot be specified in
this parameter. A prompt for requesting the password input for PKCS#12(PFX) data decoding is not
displayed.
This parameter is not displayed in the command Usage area.
Remarks
•
The PKCS#12(PFX) data files created by the following products can be processed:
Systemwalker PkiMGR
•
When no "root" CA certificate is registered, a verification error occurs and the certificate in the
PKCS#12(PFX) data is not registered.
•
The CRL contained in the PKCS#12(PFX) data file cannot be handled.
•
When a token label is specified with the -tl parameter, the token under the Slot Information
Directory specified in the -sd parameter of the cmsetnv command is retrieved.
•
When a token is specified with the -tl parameter, an exclusive error may occur while the token is
being accessed by another application.
•
Certificates in a certificate path can be registered with the nickname character string (specified in nn parameter) and a 4-digit number. This 4-digit number must begin from 0001. For example,
when "nickname" is specified in the -nn parameter, the certificates are registered with
nickname0001, nickname0002, ... starting at the higher-level path. Before the registration starts,
execute the cmlistcert command to check that there are no specified nicknames and there are no
certificates having the nickname+00*.
•
When a certificate is already registered with the same nickname or a different nickname, an error
occurs.
11-7
Chapter 11: SSL Operation Commands
cmgetcrl
Name
cmgetcrl
Collects CRL.
Synopsis
cmgetcrl
[-ed EnvDir] –url Url [-pr Proxy] [ -lc LDAPHopLimit] [-w Wait]
Description
The cmgetcrl command collects a CRL from the specified URL and stores it in the Certificate/Key
Management Environment.
The command options and arguments are explained below:
-ed EnvDir
This option specifies the absolute path of the Certificate/Key Management Environment created during
SSL environment configuration for the Interstage HTTP Server. The default is the information specified
in environment variable CMIPATH.
-url Url
This option specifies http or LDAP for the CRL collection source.
-pr Proxy
This option specifies the host name of the proxy server. The option is valid only when http is specified
for -url. If something other than http is specified for -url, this option is ignored if specified.
-lc LDAPHopLimit
This option specifies the HOP count (0 to 100) from an LDAP server to another LDAP server when a
referral is used. The option is valid only when ldap is specified for -url. If something other than ldap is
specified for -url, this option is ignored if specified.
If 0 is specified, the HOP count is not limited. The default is 5.
-w Wait
This option specifies the time (1 to 300 seconds) to wait for a response during communication with the
LDAP server. The option is valid only when ldap is specified for -url. The default is 150 seconds.
Remarks
11-8
•
The URLs that can be specified for the collection sources are only http and ldap.
•
If the host name of a proxy server is specified, a CRL is collected via the specified server. If it is not
specified, a CRL is collected directly from the source specified by -url.
•
When a CRL is stored, an existing CRL may have been issued by the same Certification Authority
(CA) and may be older than the CRL to be stored. In this case, only the new CRL is registered.
SSL Environment Setting Commands
•
The CA certificate that issued the CRL to be registered must be registered in advance. If not, an
error is reported during CRL verification.
•
If two or more CRLs are found at the specified URL, all CRLs are collected and stored.
•
The specification of the CRL collection source must follow RFC1738. If a blank needs to be
included in the URL character string, specify "%20".
•
If the port number is omitted when the CRL collection source is specified, the default port is used.
•
When a CRL is to be collected with ldap, ";binary" can be omitted from the URL. Note that no
values (such as the host name) other than the port number can be omitted.
cmlistcert
Name
cmlistcert
Outputs a list of certificates.
Synopsis
cmlistcert
[-ed Environment-directory] [-c Country] [-cn CommonName]
[-o Organization] [-ou OrganizationUnit] [-ea EMailAddress]
[-ic Country] [-icn CommonName] [-io Organization]
[-iou OrganizationUnit] [-iea EMailAddress]
[-ca] [-own] [-nn NickName]
Description
The cmlistcert command outputs, as a standard output, the information about the certificates that
correspond to specified search keys. When all of the -c, -cn, -o, -ou, -ea, -ca, -own, and -nn parameters
are omitted, a list of all the certificates is output.
The options and arguments of this command are as follows:
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-c Country
Specify a country name (Country).
-cn CommonName
Specify an alphanumeric personal name (CommonName).
-o Organization
Specify an alphanumeric organization name (Organization).
-ou OrganizationUnit
Specify an alphanumeric organization unit name (OrganizationUnit).
11-9
Chapter 11: SSL Operation Commands
-ea EMailAddress
Specify a mail address (EmailAddress).
-ic Country
Specify the country name (Country) of the certificate issuer.
-icn CommonName
Specify the alphanumeric personal name (CommonName) of the certificate issuer.
-io Organization
Specify the alphanumeric organization name (Organization) of the certificate issuer.
-iou OrganizationUnit
Specify the alphanumeric organization unit name (OrganizationUnit) of the certificate issuer.
-iea EMailAddress
Specify the mail address (EMailAddress) of the certificate issuer.
-ca
This parameter must be specified when the certificate to be registered was issued by the Certification
Authority (CA).
-own
Specify this parameter when the certificate to be registered was issued to you.
-nn NickName
Specify a nickname (NickName). A blank character cannot be specified at the beginning or end of the
character string.
Remarks
11-10
•
Only the certificates registered in the Certificate/Key Management Environment can be displayed in
a list.
•
The item name is the same as the option name.
•
Any item whose information is not set in the above options is not displayed.
•
The information items for the specified options are searched for in partial matching mode.
SSL Environment Setting Commands
cmlistcrl
Name
cmlistcrl
Outputs a list of CRL.
Synopsis
cmlistcrl
[-ed Environment-directory] [-c Country] [-cn CommonName]
[-o Organization] [-ou OrganizationUnit] [-ea EMailAddress]
Description
The cmlistcrl command outputs, as a standard output, the information about the CRLs that correspond
to specified search keys. When all of the -c, -cn, -o, -ou, and -ea parameters are omitted, a list of all the
CRL is output.
The options and arguments of this command are as follows:
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-c Country
Specify a country name (Country).
-cn CommonName
Specify an alphanumeric personal name (CommonName).
-o Organization
Specify an alphanumeric organization name (Organization).
-ou OrganizationUnit
Specify an alphanumeric organization unit name (OrganizationUnit).
-ea EMailAddress
Specify a mail address (EmailAddress).
Remarks
•
Only the CRL registered in the Certificate/Key Management Environment can be displayed in a list.
•
The item name is the same as the option name.
•
Any item whose information is not set in the above options is not displayed.
•
The information items for the specified options are searched for in partial matching mode.
11-11
Chapter 11: SSL Operation Commands
cmmakecsr
Name
cmmakecsr
Create CSR (Certificate Signing Request) data.
Synopsis
cmmakecsr
OutFile
[-ed Environment-directory] -sd Slot-directory -tl TokenLabel -of
[-f {TEXT|NOHEAD|V2} ] [-c Country] [-cn CommonName] [-o
Organization]
[-ou OrganizationUnit] [-ea EMailAddress] [-t Title] [-tel Phone]
[-l Locality] [-s State] [-sa {SHA1|MD5} ] { -kl KeyLabel | [-kt
RSA]
[-kb {512|768|1024|2048} ] } [-p UserPIN]
Description
The cmmakecsr command creates CSR(Certificate Signing Request) data having specified information
and outputs it to a file. To create a new key pair for CSR creation, the -kt or -kb parameter must always
be specified. To create the CSR by using an already created key pair, only the -kl parameter must be
specified.
The options and arguments of this command are as follows:
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory).
When this parameter is omitted, the information set in the "CMIPATH" environment variable is validated.
-sd Slot-directory
Specify the full path to the Slot Information Directory (Slot-directory).
-tl TokenLabel
Specify the registered key or register a new key to be used. Specify the token label (TokenLabel).
-of OutFile
Specify the full path to the certificate request output file (OutFile).
-f {TEXT|NOHEAD|V2}
Specify one of the following output formats:
TEXT: CSR format output (default value)
NOHEAD: Output without header
V2: S/MIME format output with applicatioin/pkcs10 header
-c Country
Specify a country name (Country).
11-12
SSL Environment Setting Commands
-cn CommonName
Specify an alphanumeric personal name (CommonName).
-o Organization
Specify an alphanumeric organization name (Organization).
-ou OrganizationUnit
Specify an alphanumeric organization unit name (OrganizationUnit).
-ea EMailAddress
Specify a mail address (EMailAddress).
-t Title
Specify a title (Title).
-tel Phone
Specify a telephone number (Phone).
-l Locality
Specify a local name (Locality).
-s State
Specify a state name (State).
-sa {SHA1|MD5}
Specify a signature algorithm.
SHA1: SHA1 algorithm (default value)
MD5: MD5 algorithm
-kl KeyLabel
Specify the label (KeyLabel) for the key to be used.
-kt RSA
Specify the type of the key to be created.
RSA: RSA key pair (default value)
-kb {512|768|1024|2048}
Specify the length of the key to be created.
512: 512 bits (default value)
768: 768 bits
1024: 1,024 bits
2048: 2,048 bits
-p UserPIN
Specify the User-PIN for accessing the token. A blank character cannot be specified. A prompt for
requesting the User-PIN input is not displayed.
This parameter is not displayed in the Usage field of the command.
11-13
Chapter 11: SSL Operation Commands
Remarks
•
Specify a Web server host name to be -cn.
•
When any of the -kt, -kb, and -sf parameters is specified, a key pair is initially created.
•
When the -kl parameter is specified, the keys of the label specified as an option parameter are
used.
•
One of the -c,-cn, -o, -ou, -ea, -t, -tel, -l, and -s parameters must always be specified.
cmmkenv
Name
cmmkenv
Creates and sets a Certificate/Key Management Environment.
Synopsis
cmmkenv
Environment-directory [-fromdir ValidCert-directory,CRL-directory]
-todir ValidCert-directory,CRL-directory
Description
The cmmkenv command creates and initializes a directory required to operate a Certificate/Key
Management Environment.
The options and arguments of this command are as follows:
Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory).
-fromdir ValidCert-directory,CRL-directory
Specify the information necessary for conversion from a general file. To create a new directory, omit this
parameter.
ValidCert-directory: Specify the full path to the certificate directory.
CRL-directory: Specify the full path to the CRL directory.
-todir ValidCert-directory,CRL-directory
Specify the directory name of the new general file to be operated.
ValidCert-directory: Specify the full path to the certificate directory.
CRL-directory: Specify the full path to the CRL directory.
Remarks
11-14
•
To specify the -fromdir and -todir parameters, delimit items with a comma. Blank characters cannot
be used.
Example: -todir d:\csslcert\cert,d:\sslcert\crl
•
For file conversion, specify the -fromdir (source directory) and -todir (target directory).
SSL Environment Setting Commands
•
The same directory cannot be specified in both the ValidCert-directory and CRL-directory of the todir parameter.
cmmkpfx
Name
cmmkpfx
Creating PKCS#12(PFX) data
Synopsis
cmmkpfx FileName [-ed Environment-directory ] {-sn slotID|-tl TokenLabel}
-nn NickName [-userPIN UserPIN][ -password Password]
Description
The cmmkpfx command retrieves an EE certificate corresponding to the specified nickname as well as a
private key from the Certificate/Key Management Environment, and those in the certificate path required
to verify the EE certificate, and outputs PKCS#12(PFX) format data file.
Enter the UserPIN and a password used to encrypt PKCS#12(PFX) data on an interactive basis.
The options and arguments of this command are as follows:
FileName
Specify the full path to the file that creates the PKCS#12(PFX) data.
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory).
-sn SlotID
Specify the SlotID set in the token for registering a private key.
-tl TokenLabel
Specify the TokenLabel set in the token for registering a private key.
It will become an error if there are two or more of the same labels.
-nn NickName
Specify a nickname (NickName).
-userPIN UserPIN
Specify the user PIN (UserPIN) for accessing the token.
-password Password
Specify a password used to encrypt PKCS#12(PFX) data. A blank character cannot be specified in this
parameter.
The password is a string of 6 to 128 characters that can be selected from the following character set.
11-15
Chapter 11: SSL Operation Commands
Table 11-1 Valid Character Sets
Category
Character set
Alphabetic characters
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Numeric characters
0123456789
Symbols
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blanks
''
Remarks
11-16
•
Unless the -userPIN and -password parameters are specified at the same time, a parameter error
occurs.
•
If the -userPIN and -password parameters are specified, no prompt appears requesting you to
enter the UserPIN and a password to encrypt PKCS#12(PFX) data.
•
For a token specified in the -tl parameter, the tokens in the Slot Information Directory specified in
the -sd parameter of the cmsetenv command are searched.
•
If a token specified in the -tl parameter is accessed by another application, an exclusive error may
occur.
•
A certificate is retrieved from those corresponding to the specified nickname and those in the
certificate path required to verify the certificate.
•
If there is no private key corresponding to the certificate with the specified nickname, this command
ends with an error.
•
If there is more than one certificate with the specified nickname, this command ends with an error.
Check the certificates using cmlistcert and, if you want to retrieve one, change its nickname using
the cmchgnickname command.
•
If the certificate does not exist in the token specified in the -sn | -tl parameter, the certificates in the
Certificate/Key Management Environment are searched.
SSL Environment Setting Commands
cmrmcert
Name
cmrmcert
Deletes a certificate.
Synopsis
cmrmcert
[-ed Environment-directory ] { -id CertID | -nn NickName }
Description
The cmrmcert command deletes a certificate from the Certificate/Key Management Environment.
The options and arguments of this command are as follows:
-ed Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory). When
this parameter is omitted, the information set in the "CMIPATH" environment variable is valid.
-id CertID
Specify the identifier (CertID) of a certificate.
-nn NickName
Specify a nickname (NickName).
Remarks
•
The -id or -nn parameter must always be specified.
•
The certificate identifier (CertID) or nickname can be checked using the cmlistcert command.
cmsetenv
Name
cmsetenv
Sets a certificate environment.
Synopsis
cmsetenv
Environment-directory -sd Slot-directory -jc LocaleCode
[-rc ContractCertList]
11-17
Chapter 11: SSL Operation Commands
Description
The cmsetenv command sets the locale-language code system required for registering a Slot
Information Directory, certificate, and CRL into a Certificate/Key Management Environment.
The options and arguments of this command are as follows:
Environment-directory
Specify the full path to the Certificate/Key Management Environment (Environment-directory).
-sd Slot-directory
Specify the full path to the Slot Information Directory (Slot-directory).
-jc LocaleCode
Specify 0 (that is, UNICODE) as locale code required to register a certificate and CRL.
-rc ContractCertList
Specify the full path to the built-in certificate list file (ContractCertList) if certificates must be registered at
environment setting.
Remarks
•
To specify the -rc parameter, a slot must be previously created with the makeslot or mkslt command
and a token must be previously created with the maketoken or mktkn command.
•
When the -rc parameter is specified and a certificate must be registered in a Certificate/Key
Management Environment, the certificate and nickname must be unique. Otherwise, the certificate
is not registered and this command terminates normally. If the same certificate is already
registered with a different nickname or another certificate is already registered with the same
nickname, this command terminates abnormally.
•
The "root" certificate built-in list files that were issued by VeriSign, Inc. can be specified in the -rc
parameter.
The specifiable built-in list files are as follows:
−
Solaris OE server: /etc/opt/FJSVisas/contractcertlist
−
Windows client: Interstage installation folder\IS_cert\contractcertlist
When this file is registered, the following certificates are registered.
11-18
−
["Root" certificates issued by VeriSign, Inc.]
−
VeriSign/RSA Secure Server CA
−
VeriSign Class 1 Public Primary Certification Authority
−
VeriSign Class 2 Public Primary Certification Authority
−
VeriSign Class 3 Public Primary Certification Authority
−
VeriSign Class 1 Public Primary Certification Authority - G2
−
VeriSign Class 2 Public Primary Certification Authority - G2
−
VeriSign Class 3 Public Primary Certification Authority - G2
−
VeriSign Class 4 Public Primary Certification Authority - G2
SSL Environment Setting Commands
ejbsetssleb
Name
ejbsetssleb
Setup of the encryption communication using SSL
Synopsis
ejbsetssleb [-M system-name] [-p port number] [-s ejb-container-name | ejbapplication-name]
Description
Sets the encryption communication using SSL.
The arguments for this command are as follows:
-M system-name
-s ejb-container-name
The EJB container which communicates SSL is specified.
-p port number
To specify the SSL communication for the EJB application that has been installed with the -d, h, p
options of the ejbinstalleb command specified, specify this option. For port number, specify the value of
config (UNO_IIOP_ssl_port) of the CORBA service.
ejb-application-name
Specifies the EJB application name that sets the encryption communication using SSL.
Notes
•
If the EJB application name begins with a hyphen, specify "--" as an argument before the
specification of the EJB application name.
•
The EJB applications that can be specified with this command are limited to the EJB applications
that can be specified for the ejbdstarteb command.
•
Do not use this command while an ejbmakeapfolder command is being executed.
•
Do not use this command while the relevant EJB application is running.
•
Do not use this command while customizing the relevant EJB application definitions or
installing/uninstalling the relevant EJB applications.
•
Do not use this command while setting and releasing the encryption communication using SSL of
the corresponding EJB application is under way.
11-19
Chapter 11: SSL Operation Commands
•
After the SSL communication is specified, if the config (UNO_IIOP_ssl_port) of the CORBA service
is changed, reinstall the EJB application.
Example
The following shows an example of specifying SSL communication to be used for the EJB container
named "EMPLOYEE."
ejbsetssleb
-s EMPLOYEE
ejbunsetssleb
Name
ejbunsetssleb
Release of the encryption communication using SSL
Synopsis
ejbunsetssleb [-M system-name] [-s ejb-container-name | ejb-applicationname]
Description
Releases the encryption communication using SSL.
The arguments for this command are as follows:
-M system-name
-s ejb-container-name
Specifies the EJB container of which SSL communication is to be canceled.
ejb-application-name
Specifies the EJB application name that releases the encryption communication using SSL.
Notes
11-20
•
If the EJB application name begins with a hyphen, specify "--" as an argument before the
specification of the EJB application name.
•
The EJB applications that can be specified with this command are limited to the EJB applications
that can be specified for the ejbdstarteb command.
•
Do not use this command while an ejbmakeapfolder command is being executed.
•
Do not use this command while the relevant EJB application is running.
SSL Environment Setting Commands
•
Do not use this command while customizing the relevant EJB application definitions or
installing/uninstalling the relevant EJB applications.
•
Do not use this command while setting and releasing the encryption communication using SSL of
the corresponding EJB application is in progress.
Example
The following shows an example of canceling the SSL communication that has been specified for use
with the EJB container named "EMPLOYEE."
ejbunsetssleb
-s EMPLOYEE
esmkchnl
Name
esmkchnl
Creates Event Channels.
Synopsis
(1) Creating an event channel (for the Event Service)
esmkchnl -g group -c channel ... [-m number] [-l locale] [-autodiscon]
[-ssl] [-w] [-host HostName -port PortNum] [-M system]
(2) Creating an event channel (for the Notification Service)
esmkchnl -g group -c channel ... [-m number] [-l locale] [-autodiscon]
[-ssl] [-w] [-host HostName -port PortNum] [-M system]
[-notify [-persist mode] [-unit unitid] [-tran | -ots] [-ptp]]
Description
Creates event channels (static generation application). This function creates one or more event
channels and gives them a group name.
The options concerning the SSL linkage are as follows
-ssl
When this option is specified, the SSL communication is performed with the event channel that is
created by the static creation.
essetup
Name
essetup
Sets up an event Service.
11-21
Chapter 11: SSL Operation Commands
Synopsis
essetup
ssl ] ]
[ -f [-p number ] [-m number ] [ -l locale
] [-autodiscon] [ -
[-M system]
Description
Sets up an Event Service in the system.
The options concerning the SSL linkage are as follows
-ssl
When this option is specified, the SSL communication is performed with the event channel that is
created dynamically.
ihsregistupin
Name
ihsregistupin
Registers user PINs.
Synopsis
ihsregistupin -f upinfile -d slotdir
Description
The ihsregistupin command registers a user PIN in the user PIN control file.
The created user PIN management file is defined in the SSLUserPINFile directive in the environment
definition file (httpd.conf) of the Interstage HTTP Server.
The options and arguments of the ihsregistupin command are as follows:
-f upinfile
Specifies the user PIN control file that the encrypted user PIN is to be stored in.
-d slotdir
Specifies the slot information directory of the private-key control environment with an absolute path or a
relative path.
User PIN Registration Procedure
1. Execute the user PIN registration command (ihsregistupin).
11-22
2.
When you are prompted for your user PIN, enter your user PIN with up to 128 characters (hidden).
3.
When you are prompted for your user PIN again, enter the same user PIN as entered above
(hidden).
SSL Environment Setting Commands
Notes
•
Execute this command with administrator authority.
•
Specify the character string of user PIN identical to the one that is used when the private-key
control environment is created.
•
The user PIN control file is overwritten and saved.
•
It is recommended that the ippregistupin command is executed from consoles or from terminals
connected by LANs which will not be accessed from outside, in order to prevent the user PIN from
running on networks to leak out.
Example
ihsregistupin -f C:\ihs\upinfile -d C:\ihs\slotdir
UserPIN:
Re-type UserPIN:
ihsregistupin -f /etc/opt/FJSVihs/upinfile -d /etc/opt/FJSVihs/slot
UserPIN:
Re-type UserPIN:
ippregistupin
Name
ippregistupin
Registers user PINs.
Synopsis
ippregistupin -f upinfile -d slotdir
Description
The ippregistupin command registers a user PIN in the user PIN control file.
This command encrypts a user PIN and registers it in the user PIN control file. Define the created user
PIN control file in the user PIN definition item (upinfile) of the SSL environment definition file.
The options and arguments of the ippregistupin command are as follows:
-f upinfile
11-23
Chapter 11: SSL Operation Commands
Specifies the user PIN control file that the encrypted user PIN is to be stored in.
-d slotdir
Specifies the slot information directory of the private-key control environment with an absolute path or a
relative path.
User PIN Registration Procedure
1. Execute the user PIN registration command (ippregistupin).
2.
When you are prompted for your user PIN, enter your user PIN (hidden).
3.
When you are prompted for your user PIN again, enter the same user PIN as entered above
(hidden).
•
Execute this command with administrator authority.
•
Specify the character string of user PIN identical to the one that is used when the private-key
control environment is created.
•
The user PIN control file is overwritten and saved.
•
It is recommended that the ippregistupin command is executed from consoles or from terminals
connected by LANs which will not be accessed from outside, in order to prevent the user PIN from
running on networks to leak out.
Notes
Example
ippregistupin -f c:\ipp\upinfile -d c:\ipp\slotdir
UserPIN:
Re-type UserPIN:
ippregistupin -f /etc/opt/FSUNprovd/upinfile -d /etc/opt/FSUNprovd/slot
UserPIN:
Re-type UserPIN:
11-24
SSL Environment Setting Commands
makeslot
Name
makeslot
Creates a slot.
Synopsis
makeslot
[-d Slot-directory]
Description
When using SMEE3 as a SSL library, use this command.
The makeslot command creates a slot.
The slot password to be set in the Slot Information Directory can be entered in interactive mode.
When the set-up slot password incorporates by generating a token, it is required.
When it succeeds in generation of a slot, the slot ID of the generated slot is output.
The options and arguments of this command are as follows:
-d Slot-directory
Specify the full path to the directory in which the slot for managing the key is to be stored.
Although it is omissible, specify and be sure to create a Slot Information Directory peculiar to application.
Remarks
The slot password is a string of 6 to 128 characters that can be selected from the following character set.
If an invalid character string is specified, the command terminates abnormally.
Table 11-2 Valid Character Sets
Category
Character set
Alphabetic characters
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Numeric characters
0123456789
Symbols
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blanks
''
Notes
Manage the slot password carefully not to leak or get stolen.
Do not use a name, word, or a character string that can easily be guessed or that consists of all same
characters. It is recommended to specify as long a character string as possible that consists of a
mixture of alphanumeric characters and symbols.
11-25
Chapter 11: SSL Operation Commands
maketoken
Name
maketoken
Generates a token.
Synopsis
maketoken
[-d Slot-directory] -s SlotID [-t TokenLabel]
Description
When you use SMEE3 as a SSL library, use this command.
The maketoken command generates a token and builds it into a slot.
The SO-PIN and user PIN to be set in the token can be entered in interactive mode.
The token of FLM03 is generated for a device model by execution of this command.
In the application program under starting, in order to confirm the generated token, an application
program reboot is required.
The options and arguments of this command are as follows:
-s Slot-directory
Specify the full path to the Slot Information Directory (Slot-directory).
When the specified Slot Information Directory does not exist, it becomes an error, and an abnormal
termination of the command is carried out.
-s SlotID
Specify the slot ID (SlotID) of the slot in which the generated token is to be built.
-t TokenLabel
Specify a string of up to 32 characters for the token label (TokenLabel) to be set in the generated token.
When the specified character string has less than 32 characters, the remaining digits are filled up with
blank characters. A blank character cannot be specified at the beginning of the character string.
When it omits, it is regarded that 2 figures (it is Token01 when a slot number is 1) of low ranks of a
Token+ slot number were specified to be.
Remarks
The token label must consist of characters selected from the following character sets. If an invalid
character string is specified, the command terminates abnormally.
Table 11-3 Valid Character Sets
11-26
Category
Character set
Alphabetic characters
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Numeric characters
0123456789
SSL Environment Setting Commands
Category
Character set
Symbols
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blanks
''
Notes
Manage the password carefully not to leak or get stolen.
For SO-PIN and User-PIN, do not use a name, word, or a character string that can easily be guessed or
that consists of all same characters. It is recommended to specify as long a character string as possible
that consists of a mixture of alphanumeric characters and symbols.
mkslt
Name
mkslt
Creates a slot.
Synopsis
mkslt
-sd Slot-directory [-Slotpasswd Slot-password]
Description
Use this command when you use SMEE2 as a SSL library.
The mkslt command creates a slot. The slot password to be set in the Slot Information Directory must
be entered in interactive mode. If the specified Slot Information Directory is not found, an error occurs
and the command processing terminates abnormally.
In case the set-up slot password incorporates by generating a token, it is needed.
When it succeeds in generation of a slot, the slot ID of the generated slot is output.
The options and arguments of this command are as follows:
-sd Slot-directory
Specify the full path to the directory in which the slot for managing the key is to be stored.
-Slotpasswd Slot-password
Specify the password (Slot-password) to be set in the slot. Blank characters cannot be specified. A
prompt for requesting password input is not displayed.
This parameter is not displayed in the Usage field of the command.
11-27
Chapter 11: SSL Operation Commands
Remarks
The slot password is a string of 6 to 128 characters that can be selected from the following character set.
If an invalid character string is specified, the command terminates abnormally.
Table 11-4 Valid Character Sets
Category
Character set
Alphabetic characters
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Numeric characters
0123456789
Symbols
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blanks
''
Notes
Manage the slot password carefully not to leak or get stolen.
Do not use a name, word, or a character string that can easily be guessed or that consists of all same
characters. It is recommended to specify as long a character string as possible that consists of a
mixture of alphanumeric characters and symbols.
mktkn
Name
mktkn
Generates a token.
Synopsis
mktkn
-sd Slot-directory -sn SlotID -tl TokenLabel
[-Slotpasswd Slot-password -SOPIN SO-PIN -UserPIN User-PIN]
Description
Use this command when you use SMEE2 as a SSL library.
The mktkn command generates a token and builds it into a slot. The SO-PIN and user PIN to be set in
the token can be entered in interactive mode.
The options and arguments of this command are as follows:
-sd Slot-directory
Specify the full path to the Slot Information Directory (Slot-directory).
When the specified Slot Information Directory does not exist, it causes an error, and an abnormal end of
the command is carried out.
11-28
SSL Environment Setting Commands
-sn SlotID
Specify the slot ID (SlotID) of the slot in which the generated token is to be built.
-tl TokenLabel
Specify a string of up to 32 characters for the token label (TokenLabel) to be set in the generated token.
When the specified character string has less than 32 characters, the remaining digits are filled up with
blank characters. A blank character cannot be specified at the beginning of the character string.
A token label is the information used when a user specifies a token. Therefore, specify a meaningful
label within the system in which a token is used.
-Slotpasswd Slot-password
Specify the password (Slot-password) set in the slot. Blank characters cannot be specified. A prompt
for requesting the password input is not displayed.
This parameter is not displayed in the Usage field of the command.
-SOPIN SO-PIN
Specify the SO-PIN required for token processing such as token password operation and token
initialization. Blank characters cannot be specified. A prompt for requesting the SO-PIN input is not
displayed.
This parameter is not displayed in the Usage field of the command.
-UserPIN User-PIN
Specify the user PIN (User-PIN) required to operate an object in a token. Blank characters cannot be
specified. A prompt for requesting the user-PIN input is not displayed.
This parameter is not displayed in the Usage field of the command.
Remarks
The token label must consist of characters selected from the following character sets. If an invalid
character string is specified, the command terminates abnormally.
Table 11-5 Valid Character Sets
Category
Character set
Alphabetic characters
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Numeric characters
0123456789
Symbols
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blanks
''
Notes
•
-Slotpasswd, -SOPIN, and -UserPIN parameter become a parameter error when not specified
simultaneously.
•
When -Slotpasswd, -SOPIN, and -UserPIN parameter are specified, the prompt that asks for an
input is not displayed.
•
Manage the password carefully not to leak or get stolen.
11-29
Chapter 11: SSL Operation Commands
For SO-PIN and User-PIN, do not use a name, word, or a character string that can easily be
guessed or that consists of all same characters. It is recommended to specify as long a character
string as possible that consists of a mixture of alphanumeric characters and symbols.
odsetSSL
Name
odsetSSL
Sets an SSL environment for a CORBA service (ObjectDirector).
Synopsis
odsetSSL
-sd Slot-directory -ed Environment-directory -tl TokenLabel
[-nn nick-name] [-level2 n] [-level3 n] [-verify m] [-M system]
Description
The odsetSSL command registers an SSL operation environment for a CORBA service.
The user PIN for SSL communication must be entered in interactive mode.
The options and arguments of this command are as follows:
-sd Slot-directory
Specify the full path to the slot information directory (Slot-directory). This parameter must not be
omitted.
-ed Environment-directory
Specify the full path to the certificate operation control directory (Environment-directory). This parameter
must not be omitted.
-tl TokenLabel
Specify the token label (TokenLabel) assigned to the token that was generated with the mktkn command.
This parameter must not be omitted.
-nn nick-name
When using the site certificate of the local host, specify the nickname of the site certificate registered
with the cmentcert command.
When setting on the server side, be sure to specify this option. When setting on the client side and
performing operation without client certificate (when SSL server function is not used), omit this option.
-level2 n
As the encryption method permitted in the communication of SSL version 2.0, specify the sum of the
following values (decimal). The default is "15".
0: SSL2.0 communication is not allowed
1: SSL_TXT_RC2_128_CBC_WITH_MD5 (128-bit key)
2: SSL_TXT_RC2_128_CBC_EXPORT40_WITH_MD5 (40-bit key)
4: SSL_TXT_DES_64_CBC_WITH_MD5 (56-bit key)
11-30
SSL Environment Setting Commands
8: SSL_TXT_DES_192_EDE3_CBC_WITH_MD5 (168-bit key)
16: SSL_TXT_RC4_128_ WITH_MD5 (128-bit key)
32: SSL_TXT_RC4_128_ EXPORT40_WITH_MD5 (40-bit key)
When "0" is specified with the -level3 option, "0" cannot be specified in this option.
-level3 n
As the encryption method permitted in the communication of SSL version 3.0, specify the sum of the
following values (decimal). The default is "28".
0: SSL3.0 communication is not allowed
1: SSL_TXT_RSA_WITH_NULL_MD5
2: SSL_TXT_ RSA_WITH_NULL_SHA
4: SSL_TXT_RSA_EXPORT_WITH_RC2_CBC_40_MD5 (40-bit key)
8: SSL_TXT_RSA_WITH_DES_CBC_SHA (56-bit key)
16: SSL_TXT_RSA_WITH_3DES_EDE_CBC_SHA (168-bit key)
32: SSL_TXT_RSA_EXPORT_WITH_RC4_40_MD5 (40-bit key)
64: SSL_TXT_RSA_WITH_RC4_128_MD5 (128-bit key)
128: SSL_TXT_RSA_WITH_RC4_128_SHA (128-bit key)
When "0" is specified with the –level2 option, "0" cannot be specified in this option.
-verify m
Specify the operation to be performed on the server side when authorizing the client in cases where no
client certificate exists in the local host in the communication with SSL version 3.0. The client does not
need to specify this option.
1: Authentication success (default value)
The authorization processing continues even if no client certificate exists in the local host.
2: Authentication failure
The system terminates in error (without certificate) if no client certificate exists in the local host.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
Notes
•
This command must be executed with the administrator authority.
•
If both SSL versions 2.0 and 3.0 are enabled in the client/server, a priority is given to Version 2.0. If
there is no matching version 2.0 encryption method between the client and server, the encryption
method that matches in version 3.0 is used.
•
If there is no client certificate (the -m option is omitted), this host cannot use the SSL function as a
CORBA server. Therefore, the message od40303 is displayed when starting the CORBA service.
11-31
Chapter 11: SSL Operation Commands
Remarks
Interstage supports the following encryption types (SSL_TXT_XXX):
•
Public-key cryptography: RSA
•
Private-key cryptosystem: DES, 3DES (triple DES), RC2, RC4 (NULL indicates no encryption.)
•
Private-key processing mode: CBC, EDE (The number indicates the block length.)
•
Hash key: SHA, MD5
Examples
Execute this command for SSL 2.0 RC4/128-bit key encryption or SSL 3.0 DES encryption.
odsetSSL -sd C:\slot -ed C:\sslcert -tl Token01 -nn Jiro -level2 16 -level3
8
odsetSSL -sd /export/home/SSL/slot -ed /export/home/SSL/sslcert -tl Token01
-nn Jiro -level2 16 -level3 8
odsetpath
Name
odsetpath
Sets access authority for the SSL environment.
Synopsis
odsetpath
Slot-directory Environment-directory [-M system]
Description
The odsetpath command sets the access authority of a general user (other than system administrator)
for an SSL information file registered with odsetSSL.
The following parameters can be specified in this command:
Slot-directory
Specify the full path to the slot information directory (Slot-directory). This parameter cannot be omitted.
11-32
SSL Environment Setting Commands
Environment-directory
Specify the full path to the certificate operation control directory (Env-dir). This parameter cannot be
omitted.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
Notes
•
This command must be executed with the administrator authority.
•
This command does not check whether the specified directory is a slot information directory or a
certificate operation control directory.
Example
odsetpath
/export/home/SSL/slot
/export/home/SSL/sslcert
scsmakeenv
Name
scsmakeenv
Creates a Certificate Signing Request (CSR).
Synopsis
[To create a certificate signing request (CSR)]
scsmakeenv -n nickname -f filename [-c] [-k keysize]
[To create a site certificate for testing]
scsmakeenv -n nickname [-c] [-k keysize] [-v valday]
Description
The scsmakeenv command creates a pair of RSA public and private keys and outputs a certificate
signing request (CSR) to a file. The command can also create a test site certificate if the option “-f
filename” is omitted. The key and site certificate for testing created by the scsmakeenv command are
registered in the Interstage certificate environment.
When executed for the first time, the command creates an Interstage certificate environment and
defines a password. Thereafter, the command uses the Interstage certificate environment according to
the defined password.
The parameters that can be specified for this command are explained below.
-n nickname
This option specifies the nickname of a private key. Specify a character string (1 to 32 characters long)
that begins with an alphanumeric character from the character set defined below.
11-33
Chapter 11: SSL Operation Commands
This option cannot be omitted.
The nickname specified with this option must be used when specifying a nickname in the scsenter
command to register the site certificate obtained from the Certification Authority (CA). Remember the
nickname for this purpose.
Note that an existing nickname cannot be specified. Note also that uppercase and lowercase letters are
not distinguished for the nickname.
The characters that can be used for the nickname are listed below:
Table 11-6 Valid Characters for Nickname
Category
Character
Alphabet
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Digit
0123456789
Symbol
()-[]_
-f filename
This option specifies the full path of the file in which the certificate signing request (CSR) created is to
be stored.
When this option is specified, the command creates a CSR and a pair of RSA keys and registers them
in the Interstage certificate environment.
If this option is omitted, the command creates a test site certificate and registers it in the Interstage
certificate environment.
-c
This option specifies that the certificate of the Certification Authority (VeriSign, Inc) be registered.
This option must be specified if a certificate is to be issued from VeriSign, Inc.
Once the command is executed with this option specified, the option need not be specified again when
the command is executed again, unless the CA certificate is deleted by the scsdelete command.
-k keysize
This option specifies the number of bits indicating the strength of the pair of RSA public key and private
key to be created. Specify 512, 768, 1024, or 2048. The default is 1024 (bits).
In recent years machine processing performance has rapidly improved, 512-bit and 768-bit RSA keys
may no longer be safe. It is recommended to specify 1024 bits or more. If operational circumstances
require the use of 512-bit or 768-bit RSA keys, use them only after considering the risk involved.
-v valday
This option specifies the number of days (1 to 7300) during which the test site certificate is valid. The
default is 365 (days).
The certificate cannot be used after the expiration of the validity term. It is recommended to specify a
period in which the test will be completed.
11-34
SSL Environment Setting Commands
Remarks
•
When executed, the command prompts for information items to be entered, such as names.
Enter the following information items. Do not omit them. If one is omitted, "Unknown" is assumed.
If the country name code is omitted, "Un" is assumed.
Table 11-7 Information to Input
Prompt message
Information to input
What is your first and last name?
Name. For a site certificate, enter the domain name
or IP address.
What is the name of your organizational unit?
Organization unit name (example: department
name)
What is the name of your organization?
Organization name (example: company name)
What is the name of your City or Locality?
City name or regional name (example: city, town,
etc.)
What is the name of your State or Province?
State name or provincial name (example: state,
province, etc.)
What is the two-letter country code for this unit?
Country code (two letters, per ISO3166). (example:
"jp" for Japan)
The following characters can be used for specification.
Table 11-8 Valid Character Sets to Input
Category
Character
Alphabet
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Digit
0123456789
Symbol
When JDK1.3.1 or an earlier version is used ()-./:?
When JDK1.4 is used (),-./:?'+=#;<>
Note: If a symbol other than the above is used, JDK may not
operate normally.
Blank
''
Note: If a blank is specified at the beginning or end, the blank is
deleted. If two or more blanks are specified consecutively or if only
blanks are specified, JDK may not operate normally.
•
When executed, the command prompts for a password.
When the command is executed for the first time, the password is registered as one used to access
the Interstage certificate environment. Specify the password using 6 to 128 characters from the
password character set defined below. Remember the password because it is required for access
the Interstage certificate environment. If this command is to be executed after it has once been
executed, enter the password already registered.
11-35
Chapter 11: SSL Operation Commands
Table 11-9 Valid Character Set for Passwords
Category
Character
Alphabet
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Digit
0123456789
Symbol
!"#%&'()*+,-./:;<=>?[\]^_{|}~
Blank
''
Notes
•
Remember the password entered when the command was first executed. Otherwise, the
scsmakeenv, scsenter, scsdelete, and scslistcrl commands cannot be executed.
•
Protect the confidentiality of the password carefully, keep it secret and do not allow it to be stolen.
Do not use a name, word, or a character string that can easily be guessed, or that consists of all
same characters. It is recommended to specify as long a character string as possible that consists
of a mixture of alphanumeric characters and symbols.
•
The site certificate created by this command can be used as a certificate for testing. Note that the
created certificate is reliable only in the test environment and its reliability cannot be guaranteed for
external environments such as the Internet. Be careful not to let it be used for regular service
operations.
•
If the command executed for the first time ends with an error, an Interstage certificate environment
may not have been created properly. If so, delete the current Interstage certificate environment and
enter the scsmakeenv command to create a new Interstage certificate environment.
The path of the Interstage certificate environment, and the resource to be deleted before the
Interstage certificate environment is re-created, are as follows:
Interstage certificate environment
C:\Interstage\etc\security
Resource to be deleted before re-creation, stored under
C:\Interstage\etc\security\env
Interstage certificate environment
/etc/opt/FJSVisscs/security
Resource to be deleted before re-creation, stored under
/etc/opt/FJSVisscs/security/env
If the Interstage certificate environment is corrupted after it is created, restore the environment.
Refer to the "Operator's Guide" for the restoration procedure.
11-36
SSL Environment Setting Commands
•
Execute this command as a user belonging to the Administrators group.
•
Execute this command as a super user.
•
To create a CSR
Example
>scsmakeenv -n SiteCert -f C:\my_folder\my_csr.txt -c
Password: (*1)
Input X.500 distinguished names.
What is your first and last name?
[Unknown]:SiteName.domain (*2)
What is the name of your organizational unit?
[Unknown]:Interstage (*2)
What is the name of your organization?
[Unknown]:Fujitsu Ltd. (*2)
What is the name of your City or Locality?
[Unknown]:Yokohama (*2)
What is the name of your State or Province?
[Unknown]:Kanagawa (*2)
What is the two-letter country code for this unit?
[Un]:jp (*2)
Is <CN=SiteName.domain, OU=Interstage, O=Fujitsu Ltd., L=Yokohama,
ST=Kanagawa, C=jp> correct?
[no]:yes (*3)
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
SCS: INFO: scs0101: CSR was issued <C:\my_folder\my_csr.txt>
> scsmakeenv -n SiteCert -f /usr/home/my_dir/my_csr.txt -c
Password: (*1)
Input X.500 distinguished names.
What is your first and last name?
[Unknown]:SiteName.domain (*2)
What is the name of your organizational unit?
[Unknown]:Interstage (*2)
What is the name of your organization?
[Unknown]:Fujitsu Ltd. (*2)
What is the name of your City or Locality?
[Unknown]:Yokohama (*2)
11-37
Chapter 11: SSL Operation Commands
What is the name of your State or Province?
[Unknown]:Kanagawa (*2)
What is the two-letter country code for this unit?
[Un]:jp (*2)
Is <CN=SiteName.domain, OU=Interstage, O=Fujitsu Ltd., L=Yokohama,
ST=Kanagawa, C=jp> correct?
[no]:yes (*3)
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
Certificate was added to keystore
UX: SCS: INFO: scs0101: CSR was issued </usr/home/my_dir/my_csr.txt>
•
*1 The entered password is not displayed. The password entered for the first time is processed for
registration. For this purpose, the system prompts for the password to be entered again, as shown
below. Retype the password for confirmation.
New Password:
Retype:
•
*2 Enter required items while referring to Notes on entries.
•
*3 To create a CSR using the displayed information, type "yes". To reenter information, type "no".
•
To create a site certificate for testing
> scsmakeenv -n testCert
Password: (*1)
Input X.500 distinguished names.
What is your first and last name?
[Unknown]:SiteName.domain (*2)
What is the name of your organizational unit?
[Unknown]:Interstage (*2)
What is the name of your organization?
[Unknown]:Fujitsu Ltd. (*2)
What is the name of your City or Locality?
[Unknown]:Yokohama (*2)
What is the name of your State or Province?
[Unknown]:Kanagawa (*2)
What is the two-letter country code for this unit?
[Un]:jp (*2)
Is <CN=SiteName.domain, OU=Interstage, O=Fujitsu Ltd., L=Yokohama,
ST=Kanagawa, C=jp> correct?
[no]:yes (*3)
UX: SCS: INFO: scs0102: Self-sign certificate was issued
11-38
SSL Environment Setting Commands
scsenter
Name
scsenter
Registers a certificate and CRL.
Synopsis
[To register a certificate]
scsenter -n nickname -f filename [-p password] [-o | -e]
[To register a CRL]
scsenter -c -f filename [-p password]
Description
The scsenter command checks whether the certificate or CRL is valid and, if it is valid, registers it in the
Interstage certificate environment. The parameters that can be specified for this command are
explained below:
-p password
This option specifies the password used to access the Interstage certificate environment. Specify the
same password as that specified by the scsmakeenv command. If this option is omitted, a prompt for
password appears.
-n nickname
This option specifies the nickname of the certificate to be registered. Specify a character string (1 to 32
characters long) that begins with an alphanumeric character from the character set defined below. To
register a site certificate issued by a Certification Authority (CA), specify the same nickname as that
specified for the private key with the scsmakeenv command.
When registering the CA certificate, specify a nickname that does not match the nickname of a
certificate already registered.
Note that nicknames are not case-sensitive (ie uppercase and lowercase letters are not distinguished).
The characters that can be used for the nickname are listed below:
Table 11-10 Valid Character Sets for Nickname
Category
Character
Alphabet
ABCDEFGHIJKLMNOPQRSTUVWXYZ
abcdefghijklmnopqrstuvwxyz
Digit
0123456789
Symbol
()-[]_
-f filename
This option specifies the full path of the file that contains certificate (site certificate or CA certificate) or a
CRL. This option cannot be omitted.
11-39
Chapter 11: SSL Operation Commands
The command can register a certificate or CRL that conforms to X.509 or RFC2459 and that uses RSA
keys.
The data format that can be specified is binary data (DER format) or Based64 encoding data (PEM
format).
To specify a certificate in Base64 encoding data (PEM format), specify data that begins with "----BEGIN
CERTIFICATE----" and ends with "----END CERTIFICATE----." To specify a CRL in Base64 encoding
data (PEM format), specify data that begins with "----BEGIN X509 CRL----" and ends with "----END X509
CRL----."
An example of the certificate in the PEM format is shown below:
-----BEGIN CERTIFICATE----(Base-64-encoded certificate data is embedded.)
-----END CERTIFICATE----An example of the CRL in the PEM format is shown below:
-----BEGIN X509 CRL----(Base-64-encoded CRL data is embedded.)
-----END X509 CRL-----o
This option specifies that the own site certificate issued by a CA be registered.
Do not specify this option when registering the CA certificate, an accompanying certificate (intermediate
CA certificate), or the certificate of another site.
-e
This option specifies that the certificate of another site be registered. The registered certificate is
handled as the certificate of a reliable site.
Do not specify this option when registering the CA certificate, an accompanying certificate (intermediate
CA certificate), or the certificate of the own site.
The registered certificate of another site can be referenced from the: Interstage management console
as follows: Interstage management console [System] > [Security] > [Certificates] > [CA Certificates]
screen.
-c
This option specifies that a CRL be registered.
Notes
11-40
•
When specifying the -p option, be careful to protect the confidentiality of the password.
•
When registering certificates, register them in order starting with the CA certificate then others.
Registration fails if the registration order is confused.
•
A CRL issued by the same CA under the same conditions as an existing CRL is registered in
overwrite mode.
•
When a CRL is to be registered, the CA certificate that issued the CRL must be registered in
advance.
•
No nickname is assigned to the registered CRL.
SSL Environment Setting Commands
•
Execute this command as a user belonging to the Administrators group.
•
Execute this command as a super user.
scsdelete
Name
scsdelete
Deletes a certificate.
Synopsis
scsdelete -n nickname [-p password]
Description
The scsdelete command deletes a certificate from the Interstage certificate environment. The
parameters that can be specified for this command are explained below:
-p password
This option specifies the password used to access the Interstage certificate environment. Specify the
same password as that specified by the scsmakeenv command. If this option is omitted, a prompt for
password appears.
-n nickname
This option specifies the nickname of the certificate to be deleted or the nickname of the private key
specified by the scsmakeenv command. This option cannot be omitted. If the nickname of a site
certificate is specified, ensure that the private key having the same nickname is also deleted.
Characters used to specify nicknames are not case-sensitive (ie uppercase and lowercase letters are
not distinguished).
Notes
•
When specifying the -p option, be careful to protect the confidentiality of the password.
•
If the CA certificate is deleted by specifying its nickname, the site certificate issued by the CA can
no longer be used.
•
If the private key is deleted by specifying its nickname, the site certificate can no longer be
registered as an own site certificate. Please be careful.
•
Execute this command as a user belonging to the Administrators group.
11-41
Chapter 11: SSL Operation Commands
•
Execute this command as a super user.
scslistcrl
Name
scslistcrl
Displays a listing of CRLs.
Synopsis
scslistcrl [-p password]
Description
The scslistcrl command lists CRLs registered in the Interstage certificate environment. The parameters
that can be specified for this command are explained below:
-p password
This option specifies the password used to access the Interstage certificate environment. Specify the
same password as that specified by the scsmakeenv command. If this option is omitted, a prompt for
password appears.
Notes
11-42
•
When specifying the -p option, be careful to keep the password confidential.
•
Execute this command as a user belonging to the Administrators group.
•
Execute this command as a super user.
SSL Environment Setting Commands
soapSetSecurity
Name
soapSetSecurity
Generation of security environment
Synopsis
soapSetSecurity
-noauth -p password [ -f keystore_path ]
[ -rc contract_cert_list] [-userenv]
soapSetSecurity -p password [ -f keystore_path ] [ -keyalg keyalg ] [userenv]
[ -alias alias_name ] [ -rc contract_cert_list ] [ -ks
key_size ]
[ -validity validity_day ]
soapSetSecurity
keystore_path ]
soapSetSecurity
[ -M systemname ]
-noauth
-p password [ -f
[-rc contract_cert_list ] [-userenv]
[ -M systemname ] -p password [ -f keystore_path ]
[ -keyalg keyalg ][-userenv] [ -alias alias_name ]
[ -rc contract_cert_list ] [ -ks key_size ]
[ -validity validity_day ]
Description
The soapSetSecurity command creates a pair of public and private keys, a file (keystore file) to store a
certificate, and a Web service security environment file for the SSL-encrypted communication and high
reliability Web service function.
-M systemname
Specify the target multisystem name.
If this option is omitted, the default system is specified as a target.
-noauth
Use this option when no client is to be authenticated, no SOAP digital signature is to be affixed, or no
data is to be decrypted with the XML encryption in SSL-encrypted communication. When this option is
specified, no site certificate is required because no private key is created. If this option is specified
when client authentication is required for the connection destination server, communication may not be
possible.
11-43
Chapter 11: SSL Operation Commands
The -alias and -ks options need not be specified when this option is specified.
Always specify the -alias option when a client is to be authenticated, a SOAP digital signature is affixed,
or encrypted data is to be decrypted with the XML encryption in SSL-encrypted communication.
-f keystore_path
Specify the directory where a keystore file is created. This directory must be created in advance (do not
write any character other than the ASCII character in keystore_path). If this option is omitted, a keystore
file is created as follows:
C:\Interstage\F3FMsoap\etc
/opt/FJSVsoap/etc/
−
When the default is specified as the -M option.
−
When the -M option is omitted and the default is set in environment variable IS_SYSTEM or
environment variable IS_SYSTEM is absent
/opt/FJSVsoap/MI/”SystemName”/etc
−
When a multisystem name is specified in the -M option. (A value specified in environment
variable IS_SYSTEM becomes invalid.)
−
When the -M option is omitted and a multisystem name is set in environment variable
IS_SYSTEM
/opt/FJSVsoap/etc/
-p password
Specify a password to access the keystore file. This option cannot be omitted. The specified password
is necessary for keystore management. Be sure to specify this option.
Use six or more ASCII characters to specify a password.
Take care that the password is not discoverable by others.
-rc contract_cert_list
Specify the name of an incorporated certificate list file.
A root certificate issued from VeriSign Japan K.K or Japan Certificate Services, Inc. which is included in
Interstage can be registered in the specified file.
When no client is to be authenticated, this file can be specified for server authentication.
The installed certificate list file packed with Interstage is shown below:
11-44
SSL Environment Setting Commands
C:\Interstage\IS_cert\contractcertlist
/etc/opt/FJSVisas/contractcertlist
-alias alias_name
Specify an alias for the private key.
Always specify this option when a client is to be authenticated, a SOAP digital signature is to be affixed,
or encrypted data is to be decrypted with the XML encryption in SSL-encrypted communication. The
specified alias must be specified in registering a site certificate obtained from the authentication
authority. Be sure to specify this option.
Use an ASCII character string starting with an alphanumeric character to specify the alias.
-ks key_size
Specify length of a pair of public and private keys by selecting 512, 768, 1024, or 2048 bit.
2048 cannot be specified for a pair with the DSA algorithm.
If this option is omitted, 1024 is specified.
-validity validity_day
Specify the available period of the private key by using day as the unit. A period longer than that
specified in this option cannot be specified as the period available for a site certificate to be obtained.
If this option is omitted, 365 is specified.
-keyalg keyalg
Specify the algorithm to be used to create a pair of public and private keys by selecting DSA or RSA.
−
RSA: A pair of keys can be shared for the SSL communication, SOAP digital signature, and
XML encryption when this algorithm is used to create it.
−
DSA: A pair of keys usable for the SOAP digital signature is created with this algorithm.
The default is RSA.
–userenv
Use this option to manage a key and certificate specific to the high reliability Web service function in
addition to those for the SSL-encrypted communication.
When this option is omitted, the same pair of public and private keys, the same file (keystore file) to
store certificates, and the same Web service security environment information file are used for the SSLencrypted communication and the high reliability Web service function.
X.500 ID
When the -noauth option is not specified (client authentication is used), the X.500 Distinguished Names
listed below are requested while this command is executed. The specified X.500 Distinguished Names
are contained in a certificate and used to identify the certificate owner.
11-45
Chapter 11: SSL Operation Commands
−
commonName (abbreviated name: CN)
Commonly used personal name
[Example] "Fujitsu Taro"
−
organizationUnit (abbreviated name: OU)
Name of small organizations (such as departments and sections)
[Example] "Interstage project"
−
organizationName (abbreviated name: O)
Name of large organizations
[Example] "Fujitsu Ltd."
−
localityName (abbreviated name: L)
Area (City) name
[Example] "Yokohama"
−
stateName (abbreviated name: S)
Prefecture name or region name
[Example] "Kanagawa"
−
country (abbreviated name: C)
2-character country number conforming to the International Standard ISO3166-1981
[Example] ""jp" and "us"
The specified X.500 Distinguished Names are set in a certificate signing request (CSR) created with the
soapMngSecurity command and represented on a site certificate issued from an authentication authority
where the CSR is submitted. The identification names can be changed before issuing the site certificate.
Contact the authority to change them.
It is recommended (though not required) to specify all identifiers, because these facilitate identification
of the certificate owner.
For input of the X.500 Distinguished Names, see the example.
Notes
11-46
•
Use this command for creating a private key after creating a certificate management environment.
A keystore file created previously can be used but the password to access it cannot be changed
with this command. If the password is to be changed, use the soapMngSecurity command.
•
Do not execute this command simultaneously with other soapSetSecurity or soapMngSecurity
commands.
•
Examples (The bold character strings are data items to be input.)
SSL Environment Setting Commands
Example
1. An SSL-encrypted communication environment without client authentication is created.
> soapSetSecurity -noauth -p password
ISSOAP: INFO: issoap4101: soapSetSecurity command was finished normally.
2. An SSL-encrypted communication environment with client authentication is created.
> soapSetSecurity -p password -alias myCert
Input X.500 distinguished names.
What is your first and last name?
[Unknown]: Taro Fujitsu
What is the name of your organizational unit?
[Unknown]: Interstage
What is the name of your organization?
[Unknown]: Fujitsu Ltd.
What is the name of your City or Locality?
[Unknown]: Yokohama
What is the name of your State or Province?
[Unknown]: Kanagawa
What is the two-letter country code for this unit?
[Unknown]: jp
Is <CN=Fujitsu Taro, OU=Interstage, O="Fujitsu, Ltd.", L=Yokohama,
ST=Kanagawa,C=jp> correct?
[no]: yes
ISSOAP: INFO: issoap4101: soapSetSecurity command was finished normally.
3. A root certificate issued from VeriSign Japan K.K or Japan Certificate Services, Inc. is registered.
> soapSetSecurity -p password -alias myCert –rc
C:\Interstage\IS_cert\contractcertlist
Input X.500 distinguished names.
What is your first and last name?
[Unknown]: Taro Fujitsu
What is the name of your organizational unit?
[Unknown]: Interstage
What is the name of your organization?
[Unknown]: Fujitsu Ltd.
What is the name of your City or Locality?
[Unknown]: Yokohama
What is the name of your State or Province?
[Unknown]: Kanagawa
What is the two-letter country code for this unit?
[Unknown]: jp
Is <CN=Fujitsu Taro, OU=Interstage, O="Fujitsu, Ltd.", L=Yokohama,
ST=Kanagawa,C=jp> correct?
[no]: yes
Certificate was added to keystore
success import certificate (alias=VeriSign_SecureServer).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class2_PCA_G2_v2).
11-47
Chapter 11: SSL Operation Commands
Certificate was added to keystore
success import certificate (alias=VeriSign_Class3_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class4_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA1ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA2ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA3ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class1_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=JCS_CA1).
Certificate was added to keystore
success import certificate (alias=JCS_CA2).
Certificate was added to keystore
success import certificate (alias=JCS_CA3).
ISSOAP: INFO: issoap4101: soapSetSecurity command was finished normally.
1. An SSL-encrypted communication environment without client authentication is created.
> soapSetSecurity -noauth -p password
UX: ISSOAP: INFO: issoap4101: soapSetSecurity command was finished
normally.
2. An SSL-encrypted communication environment with client authentication is created
> soapSetSecurity -p password -alias myCert
Input X.500 distinguished names.
What is your first and last name?
[Unknown]: Taro Fujitsu
What is the name of your organizational unit?
[Unknown]: Interstage
What is the name of your organization?
[Unknown]: Fujitsu Ltd.
What is the name of your City or Locality?
[Unknown]: Yokohama
What is the name of your State or Province?
[Unknown]: Kanagawa
What is the two-letter country code for this unit?
[Unknown]: jp
Is <CN=Fujitsu Taro, OU=Interstage, O="Fujitsu, Ltd.", L=Yokohama,
ST=Kanagawa,C=jp> correct?
[no]: yes
UX: ISSOAP: INFO: issoap4101: soapSetSecurity command was finished
normally.
11-48
SSL Environment Setting Commands
3. A root certificate issued from VeriSign Japan K.K or Japan Certificate Services, Inc. is registered.
> soapSetSecurity -p password -alias myCert -rc
/etc/opt/FJSVisas/contractcertlist
Input X.500 distinguished names.
What is your first and last name?
[Unknown]: Taro Fujitsu
What is the name of your organizational unit?
[Unknown]: Interstage
What is the name of your organization?
[Unknown]: Fujitsu Ltd.
What is the name of your City or Locality?
[Unknown]: Yokohama
What is the name of your State or Province?
[Unknown]: Kanagawa
What is the two-letter country code for this unit?
[Unknown]: jp
Is <CN=Fujitsu Taro, OU=Interstage, O="Fujitsu, Ltd.", L=Yokohama,
ST=Kanagawa,C=jp> correct?
[no]: yes
Certificate was added to keystore
success import certificate (alias=VeriSign_SecureServer).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class2_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class3_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class4_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA1ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA2ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_PCA3ss_v4).
Certificate was added to keystore
success import certificate (alias=VeriSign_Class1_PCA_G2_v2).
Certificate was added to keystore
success import certificate (alias=JCS_CA1).
Certificate was added to keystore
success import certificate (alias=JCS_CA2).
Certificate was added to keystore
success import certificate (alias=JCS_CA3).
UX: ISSOAP: INFO: issoap4101: soapSetSecurity command was finished
normally.
11-49
Chapter 11: SSL Operation Commands
soapMngSecurity
Name
soapMngSecurity
Certificate application/registration/operation
Synopsis
(1) To create a certificate signing request (CSR)
soapMngSecurity -certreq -alias alias_name -f filename -p password [userenv]
(2) To register a site certificate and certification authority certificate with the keystore
soapMngSecurity -import -alias alias_name -f filename -p password [ own ]
[-userenv]
(3) To retrieve a site certificate and certification authority certificate from the keystore
soapMngSecurity -export -alias alias_name -f filename -p password [ rfc ]
[-userenv]
(4) To display the contents of a site certificate or certification authority certificate registered in the
keystore
soapMngSecurity -list [-alias alias_name] -p password [ -v ] [-userenv]
(5) To change the password for keystore access
soapMngSecurity -keypasswd -p password -new new_password [-userenv]
(6) To delete various certificates or private keys registered in the keystore
soapMngSecurity -delete -alias alias_name -p password [ -delcert ] [userenv]
(7) To specify a certificate and private key to be used with SSL communication and high reliability Web
service function .
soapMngSecurity -setenv { -alias alias_name | -noauth } -p password [userenv]
11-50
SSL Environment Setting Commands
(1) To create a certificate signing request (CSR)
soapMngSecurity -certreq [ -M systemname ] -alias alias_name -f filename
–p password [-userenv]
(2) To register a site certificate and certification authority certificate with the keystore
soapMngSecurity -import [ -M systemname ] -alias alias_name -f filename
-p password [ -own ] [-userenv]
(3) To retrieve a site certificate and certification authority certificate from the keystore
soapMngSecurity -export [ -M systemname ] -alias alias_name -f filename
-p password [ -rfc ] [-userenv]
(4) To display the contents of a site certificate or certification authority certificate registered in the
keystore
soapMngSecurity -list [ -M systemname ] -alias alias_name -p password [ v ]
[-userenv]
(5) To change the password for keystore access
soapMngSecurity -keypasswd [ -M systemname ] -p password
new_password
[-userenv]
-new
(6) To delete various certificates or private keys registered in the keystore
soapMngSecurity -delete [ -M systemname ] -alias alias_name -p password
[ -delcert ] [-userenv]
11-51
Chapter 11: SSL Operation Commands
(7) To specify a certificate and private key to be used with SSL communication and high reliability Web
service function .
soapMngSecurity -setenv [ -M systemname ] { -alias alias_name | -noauth }
-p password [-userenv]
Description
The soapMngSecurity command creates a certificate signing request (CSR) to obtain certificates
required for the SSL-encrypted communication and high reliability Web service function. The command
also registers certificates and private keys in the keystore, retrieves them from it, displays the contents
of each certificate, deletes certificates and private keys, and specifies certificates and private keys to be
used with the SSL-encrypted communication and high reliability Web service function.
-M systemname
Specify the target multisystem name.
If this option is omitted, the default system is specified as a target.
-certreq
Creates a certificate signing request (CSR).
-import
Registers site certificates and certification authority certificates in the keystore.
-export
Retrieves site certificates and certification authority certificates from the keystore.
-list
Displays the contents of the site certificates and certification authority certificates registered in the
keystore..
-keypasswd
Changes the password for keystore access.
-delete
Deletes unnecessary certificates and private keys registered in the keystore.
(Note )
Since all information items registered with the specified alias are deleted from a keystore, the acquired
site certificate cannot be re-registered.
If only a certificate is deleted without deleting a private key, specify -delcert.
-setenv
Specify certificates and private keys to be used for each security environment from the keystore.
-f filename
When the -certreq option is specified, specify the name of a file to store the certificate signing request
(CSR).
11-52
SSL Environment Setting Commands
If the -import option is specified, specify the name of the file in which the certificate (site certificate,
certification authority certificate, or PKCS#7 format certificate) is stored.
If the -export option is specified, specify the name of the file to which certificates are to be output.
Use only ASCII characters to specify the file name.
-alias alias_name
When the -certreg option is specified, specify the same alias as the private key specified with the
soapSetSecurity command.
When the -import option is specified, specify an alias given to the certificate.
When storing a site certificate issued from the certification authority for the CSR, specify the same alias
as the private key specified with the soapSetSecurity command.
When the -export option is specified, specify the alias of the certificate to be retrieved.
When the -list option is specified, specify the alias of the displayed certificate.
When the -keypasswd option is specified, specify the same alias as the private key specified with the
soapSetSecurity command.
When the -delete option is specified, specify the alias of the certificate to be deleted or the alias of the
private key specified with the soapSetSecurity command. When the private-key alias is specified, the
corresponding site certificate is also deleted.
When the -setenv option is specified, specify the alias of the private key specified with the
soapSetSecurity command. Then, an SSL-encrypted communication environment with client
authentication is created.
Use an ASCII character string starting with an alphanumeric character to specify the alias.
-p password
Specify the password to access the keystore.
Use six or more ASCII characters to specify the password.
Take care that the password is not discoverable by others.
-new new_password
This option is valid when the -keypasswd option is specified. Specify a new password for accessing the
keystore.
Use six or more ASCII characters to specify the password.
Take care that the password is not discoverable by others.
-rfc
This option is valid when the -export option is specified and the certificate is output in a printable
encoding format (Base64 encoding).
-v
This option is valid when the -list option is specified and information such as the certificate owner, issuer,
and serial number is displayed in a readable format.
-own
This option is valid when the -import option is specified. Specify this option to register a site certificate
issued from the authentication authority for a CSR.
11-53
Chapter 11: SSL Operation Commands
-delcert
This option is valid when the -delete option is specified. Specify this parameter if only the site certificate
is to be deleted.
-noauth
This option is valid when the -setenv option is specified. Specify this parameter to change the
communication environment to an SSL-encrypted communication environment without client
authentication.
-userenv
Specify this option to manage a key and certificate specific to the high reliability Web service function in
addition to those for the SSL-encrypted communication .
When this option is omitted, the same pair of public and private keys, the same file (keystore) to store
certificates, and the same Web service security environment information file are used for the SSLencrypted communication and the high reliability Web service function .
Notes
•
Do not execute this command simultaneously with other soapSetSecurity or soapMngSecurity
commands.
•
Execute this command with administrator authority.
Example
1) A certificate signing request (CSR) is created.
> soapMngSecurity -certreq -alias myCert -f C:\tmp\cert_req -p password
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
2) Site certificates are registered (PKCS#7 format).
> soapMngSecurity -import -alias myCert -f C:\tmp\myCert.p7c -p password own
Top-level certificate in reply:
Owner: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 1
Valid from: Sat Apr 13 10:53:05 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 77:79:44:52:E2:1E:E2:00:0B:A8:6D:CC:BF:26:66:16
SHA1: 99:13:D0:E4:1F:40:98:B7:61:83:1E:C7:7D:46:AA:9B:04:FD:A8:90
... is not trusted. Install reply anyway? [no]: yes
Certificate reply was installed in keystore
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
11-54
SSL Environment Setting Commands
3) Certificates are retrieved.
> soapMngSecurity -export -alias myCert -f C:\tmp\myCert.cer -p password
Certificate stored in file <C:\tmp\myCert.cer>
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
4) Certificates are displayed.
> soapMngSecurity -list -alias myCert -p password -v
Alias name: myCert
Creation date: Fri Apr 26 14:33:25 JST 2002
Entry type: keyEntry
Certificate chain length: 2
Certificate[1]:
Owner: CN=Taro Fujitsu, OU= Interstage, O=Fujitsu Ltd., L=Yokohama,
ST=Kanagawa,C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 5e0
Valid from: Sat Apr 26 14:14:24 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 8D:17:17:7F:87:3B:EE:8E:98:FD:42:CC:4C:18:E5:5B
SHA1: 10:B8:15:1F:E9:9E:F3:8A:AE:25:E4:80:36:AB:35:47:EA:A0:E0:A4
Certificate[2]:
Owner: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 1
Valid from: Sat Apr 13 10:53:05 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 77:79:44:52:E2:1E:E2:00:0B:A8:6D:CC:BF:26:66:16
SHA1: 99:13:D0:E4:1F:40:98:B7:61:83:1E:C7:7D:46:AA:9B:04:FD:A8:90
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
5) Certificates are deleted.
> soapMngSecurity -delete -alias myCert -p password
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
6) The password for keystore access is changed.
> soapMngSecurity -keypasswd -alias myCert -p password -new newpassword
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
11-55
Chapter 11: SSL Operation Commands
7) The certificate and private key that are used in the security environment are changed.
> soapMngSecurity -setenv -alias myCert1 -p password
ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
1) A certificate signing request (CSR) is created.
> soapMngSecurity -certreq -alias myCert -f /tmp/cert_req -p password
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
2) Site certificates are registered (PKCS#7 format).
> soapMngSecurity -import -alias myCert -f /tmp/Cert.p7c -p password -own
Top-level certificate in reply:
Owner: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 1
Valid from: Sat Apr 13 10:53:05 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 77:79:44:52:E2:1E:E2:00:0B:A8:6D:CC:BF:26:66:16
SHA1: 99:13:D0:E4:1F:40:98:B7:61:83:1E:C7:7D:46:AA:9B:04:FD:A8:90
... is not trusted. Install reply anyway? [no]: yes
Certificate reply was installed in keystore
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
3) Certificates are retrieved.
> soapMngSecurity -export -alias myCert -f /tmp/Cert.cer -p password
Certificate stored in file </tmp/Cert.cer>
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
11-56
SSL Environment Setting Commands
4) Certificates are displayed.
> soapMngSecurity -list -alias myCert -p password -v
Alias name: myCert
Creation date: Fri Apr 26 14:33:25 JST 2002
Entry type: keyEntry
Certificate chain length: 2
Certificate[1]:
Owner: CN=Taro Fujitsu, OU= Interstage, O=Fujitsu Ltd., L=Yokohama,
ST=Kanagawa,C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 5e0
Valid from: Sat Apr 26 14:14:24 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 8D:17:17:7F:87:3B:EE:8E:98:FD:42:CC:4C:18:E5:5B
SHA1: 10:B8:15:1F:E9:9E:F3:8A:AE:25:E4:80:36:AB:35:47:EA:A0:E0:A4
Certificate[2]:
Owner: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Issuer: EmailAddress=ssl@url.address, T=rootca, CN=naoca, OU=infoca,
OU=ohnoproject,
OU=second, OU=software, OU=FJH, O=Fujitsu, L=kanazawa, ST=ishikawa, C=jp
Serial number: 1
Valid from: Sat Apr 13 10:53:05 JST 2002 until: Sun Apr 13 10:53:05 JST
2003
Certificate fingerprints:
MD5: 77:79:44:52:E2:1E:E2:00:0B:A8:6D:CC:BF:26:66:16
SHA1: 99:13:D0:E4:1F:40:98:B7:61:83:1E:C7:7D:46:AA:9B:04:FD:A8:90
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
5) Certificates are deleted.
> soapMngSecurity -delete -alias myCert -p password
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
6) The password for keystore access is changed.
> soapMngSecurity -keypasswd -alias myCert -p password -new newpassword
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
7) The certificate and private key that are used in the security environment are changed.
> soapMngSecurity -setenv -alias myCert1 -p password
UX: ISSOAP: INFO: issoap4105: soapMngSecurity command was finished normally.
11-57
Chapter 11: SSL Operation Commands
11-58
Part 5
OLTP System Operation Edition
Chapter 12
Component Transaction Service Operation
Commands
This chapter details the Component Transaction Service operation commands.
Note
The Component Transaction Service operation command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
Note: If Plus is used, only the following command can be used.
−
tdunsetup
12-1
Chapter 12: Component Transaction Service Operation Commands
tdadddef
Name
tdadddef
Registers a Component Transaction Service WorkUnit definition.
Synopsis
tdadddef [-M system-name] [-o] work-unit-definition-file-name
Description
This command registers a Component Transaction Service WorkUnit definition.
The option and argument of this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-o
If definition information with the same name already exists, the existing definition information is
overwritten, otherwise, new definition information is written. If this option is omitted, definition information
is written only if definition information with the same name does not exist.
work-unit-definition-file-name
Specify the filename of the text file specified in the WorkUnit definition. If the filename contains blank
characters, specify the filename within single or double quotes.
Notes
12-2
•
Incomplete definitions cannot be registered.
•
This command cannot be used to register WorkUnit definitions in which a type other than ORB or
WRAPPER is specified as the WorkUnit type. Use the isaddwudef command to register WorkUnit
definitions in which a type other than ORB or WRAPPER is specified as the WorkUnit type.
tdadddef
Examples
Register the WorkUnit definition according to the file “create-def.wu”.
tdadddef create-def.wu
Overwrite the WorkUnit definition specified in the file “create-def.wu”.
tdadddef -o create-def.wu
12-3
Chapter 12: Component Transaction Service Operation Commands
tddeldef
Name
tddeldef
Deletes Component Transaction Service WorkUnit definition information.
Synopsis
tddeldef
[-M system-name] work-unit-name...
Description
This command deletes the specified Component Transaction Service WorkUnit definition information.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
work-unit-name
Specify the WorkUnit names. Multiple WorkUnit names can be specified, with each name delimited by a
space. If wildcards (“*”) are used to specify a WorkUnit name, the definition name must be enclosed
within single or double quotes.
Note
This command cannot be used to delete WorkUnit definitions in which a type other than ORB or
WRAPPER is specified as the WorkUnit type. Use the isdelwudef command to delete WorkUnit
definitions in which a type other than ORB or WRAPPER is specified as the WorkUnit type.
Examples
Delete WorkUnit definitions starting with “TDSAMPLE”
tddeldef “TDSAMPLE*”
Delete WorkUnit definitions of WorkUnits “TDSAMPLE1” and “TDSAMPLE2”
tddeldef TDSAMPLE1 TDSAMPLE2
12-4
tdinfobj
tdinfobj
Name
tdinfobj
Displays details of objects of a WorkUnit or WRAPPER WorkUnit of the transaction application.
Synopsis
tdinfobj
object-name
Description
This command displays the following detailed information about the WorkUnit or WRAPPER WorkUnit of
the transaction application object being used:
•
Object name
•
Object status. The following statuses can be entered:
−
active: Operating
−
inhibit: Closed
•
Multi level processes of the application corresponding to the object
•
The number of client requests for the object
•
The name of the WorkUnit that defines the object
The argument of this command is as follows:
object-name
Displays the NAME of the object that displays detail information.
Note
Do not execute this command when isstopwu or tdstopwu is running.
This command is only available in the default system.
12-5
Chapter 12: Component Transaction Service Operation Commands
Example
tdinfobj TDSAMPLE1/INTF
objectname
status
queue
procnum
wuname
12-6
:
:
:
:
:
TDSAMPLE1/INTF
active
10
1
TDSAMPLE1
tdinhibitobj
tdinhibitobj
Name
tdinhibitobj
Closes Component Transaction Service objects.
Synopsis
tdinhibitobj
[-M system-name] objname
Description
This command closes Component Transaction Service objects being used.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
objname
Displays the NAME of the object to be closed.
Notes
•
This command is valid for transaction applications only.
•
This command is not valid for processing continued using the Process Binding function.
•
Only the user who started the WorkUnit can close an object.
Example
tdinhibitobj TDSAMPLE1/INTF
12-7
Chapter 12: Component Transaction Service Operation Commands
tdlinkapm
Name
tdlinkapm
Generates the Application Program Manager (APM).
Synopsis
tdlinkapm -l xa_linkpgm [-t{thread|process}] [-p "library" ] -r "library" -o
apmname
Description
This command generates the Application Program Manager (APM).
Execution of this command operates the link command of Microsoft® Visual® C++.
The options and arguments of this command are as follows:
-l xa_linkpgm
For xa_linkpgm, specify a file extension “LIB” created by the otsmkxapgm command.
-r "library"
Specifies the path and filenames of the libraries provided by the database vendor (up to 2048
characters) for XA interface linkage.
The program name for XA cooperation is specified to be xa_linkpgm. The program name for XA
cooperation should use the thing which OTS offers, or the thing acquired by the otsmkxapgm command.
-t {thread|process}
Links libthread.so when thread is specified.
If process is specified, libthread.so is not linked.
This option defaults to thread when omitted.
12-8
tdlinkapm
Links libpthread.so when thread is specified.
If process is specified, libpthread.so is not linked.
This option defaults to thread when omitted.
-p "library"
The library information (up to 2048 characters) specified in “library” is linked before any other libraries.
-r "library"
Specifies the path and filenames of the libraries provided by the database vendor (up to 2048
characters) for XA interface linkage.
-o apmname
Specifies the name of the APM file to be created, using up to 23 alphanumeric characters.
The APM is created in the C:\INTERSTAGE\Extp\bin.
The APM is created in the /opt/FSUNextp/bin.
The APM is created in the /opt/FJSVextp/bin.
If the name of an existing file is specified, the operator is asked whether to overwrite the file (Y or N).
Enter “Y” to overwrite the file.
If the applicable APM is already being used, the file cannot be overwritten. TDNORM and TDNORMCNT
cannot be specified as an APM name.
12-9
Chapter 12: Component Transaction Service Operation Commands
Notes
•
Only system administrators are authorized to execute this command.
•
Do not specify a library other than those provided by the database vendor at the -r option.
•
This command uses Microsoft® Visual® C++.
•
After the installation of VC++, set the following environment variables before command execution:
PATH
INCLUDE
LIB
•
This command uses the C compiler (CC). Before executing the command, add the directory
containing the C compiler to the environment variable PATH.
•
Use the compiler indicated by the Installation Guide.
•
When using Symfoware/RDB, specify the library of the product required in Symfoware/RDB in the
environment variable LD_LIBRARY_PATH, and execute this command.
•
This command uses the C compiler (gcc). Before executing the command, add the directory
containing the C compiler to the environment variable PATH.
Examples
[APM creation by Oracle8.0.5]
tdlinkapm -l D:\temp\ots\otsoraxa.lib
-r “c:\orant\rdbms80\xa\xa80.lib c:\orant\oci80\msvc\ora80.lib”
-o orardb
[APM creation by Symfoware/RDB]
tdlinkapm -l D:\temp\ots\otssymxa.lib
-r “c:\SFWSV\ESQL\LIB\F3cwdrv.lib c:\SFWSV\ESQL\LIB\F3cwxa.lib” -o rdb
[APM creation by SQL Server]
tdlinkapm -l D:\temp\ots\mssqlpgm.lib
-r “XASWITCH.OBJ” -o mssql
12-10
tdlinknormapm
tdlinknormapm
Name
tdlinknormapm
Re-creates the APM (Application Program Manager).
Synopsis
tdlinknormapm [-M system-name] [-t{thread|process}] -p “library” [-o
apmname]
Description
The tdlinknormapm command links any library at the beginning and re-creates the APM (Application
Program Manager).
Below are the options and arguments of the tdlinknormapm command.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-t {thread|process}
Links libthread.so when thread is specified.
If process is specified, libthread.so is not linked.
This option defaults to thread when omitted.
Links libpthread.so when thread is specified.
If process is specified, libpthread.so is not linked.
This option defaults to thread when omitted.
-p "library"
The library information (up to 2048 characters) specified in “library” is linked before any other libraries.
12-11
Chapter 12: Component Transaction Service Operation Commands
-o apmname
Specify in apmname the name of the APM file to be created using up to 23 alphanumeric characters
starting with TDNORM or TDNORMCNT. If omitted, it is assumed that “TDNORM” is specified.
The APM is created in the FSUNextp installation directory/bin. If this option is omitted, or an existing file
name is specified, the operator is asked whether to overwrite the file (Y or N). Enter “Y” to overwrite the
file. If that APM is currently in use, it will not be overwritten.
Notes
•
Only system administrators are authorized to execute this command.
•
This command uses the C compiler (CC). Before executing the command, add the directory
containing the C compiler to the environment variable PATH.
•
Use the compiler indicated by the Installation Guide.
•
This command uses the C compiler (gcc). Before executing the command, add the directory
containing the C compiler to the environment variable PATH.
Example
..
tdlinknormapm -t thread -p “-L/xxx/xxx/lib -lxxx” -o TDNORMxxx
..
12-12
tdlistobj
tdlistobj
Name
tdlistobj
Displays a list of objects of a WorkUnit or WRAPPER WorkUnit of the transaction application.
Synopsis
tdlistobj
Description
This command displays the operational status of all WorkUnits of the transaction application or
WRAPPER WorkUnit objects being used.
The following information is displayed:
•
Object name
•
Operational status. The following statuses can be entered:
•
−
active: Operating
−
inhibit: Closed
The name of the WorkUnit that defines the object
Note
This command is only available in the default system.
Example
tdlistobj
objectname
TDSAMPLE1/INTF
TDSAMPLE2/INTF
status
active
inhibit
wuname
TDSAMPLE1
TDSAMPLE2
12-13
Chapter 12: Component Transaction Service Operation Commands
tdpermitobj
Name
tdpermitobj
Cancels closure of Component Transaction Service objects.
Synopsis
tdpermitobj [-M system-name] objname
Description
This command cancels the closure of Component Transaction Service objects being used.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
objname
Specify the name of the object whose closure is to be cancelled.
Note
This command is valid only for transaction applications.
Only the user that closed the object can cancel the object closure.
Example
tdpermitobj TDSAMPLE1/INTF
12-14
tdsecmode
tdsecmode
Name
tdsecmode
Enhances the security of the Component Transaction Service.
Synopsis
tdsecmode [-M systemname] ownername [setupdir]
Description
This command enhances the security of the operating environment for the component transaction
service.
The option and argument for this command is as follows:
-M systemname
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
ownername
Specify a specific user name. When only the super user executes this operation, specify the user name
of the super user.
setupdir
Specify the directory of the operating environment for the component transaction service, which is the
path defined in "ID path for system" of the Interstage operating environment definition at initialization of
Interstage.
Note
Only superusers are authorized to execute this command.
Example
tdsecmode –M system1 user1
12-15
Chapter 12: Component Transaction Service Operation Commands
tdsetup
Name
tdsetup
Generates the TD operating environment
Synopsis
tdsetup setupdir
Description
This command creates a new TD operating environment.
The operand for this command is as follows:
setupdir
Specify the folder for creating the TD operating environment.
Notes
•
Only system administrators are authorized to execute this command.
•
This command cannot be executed in the following circumstances:
−
When the TD is running
−
When the tdsetup command is executing
−
When the tdunsetup command is executing
−
When the tdadddef command is executing
−
When the tddeldef command is executing
•
An error occurs if the folder or file having the name td001 exists in the setupdir, or in the folder
where this command is specified.
•
This command is only available in the default system.
Example
tdsetup F:\td
12-16
tdstart
tdstart
Name
tdstart
Starts the TD.
Synopsis
tdstart [-M system-name]
Description
This command starts the transaction system.
The argument for this command is as follows:
-M systemname
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified
Notes
•
Only system administrators are authorized to execute this command.
•
This command cannot be used with the tdsetup or tdunsetup commands.
•
When using session information control and user authentication, start the Naming Service before
executing the tdstart command.
•
You are advised to use the Interstage setup command, rather than a job system operation with this
command.
•
Set the TD home directory in environment variable TD_HOME before starting the TD.
•
When using global transactions, set the environment variable OTS_HOME to the OTS home
directory before starting TD.
Example
Tdstart
12-17
Chapter 12: Component Transaction Service Operation Commands
tdstop
Name
tdstop
Stops the TD.
Synopsis
tdstop [-M system-name] [-c]
Description
This command stops the transaction system.
There are two modes for stopping the transaction system:
•
Normal stop
•
Forced stop
Normal stop stops the transaction system only when the WorkUnit is stopped. If the WorkUnit is active,
the transaction system cannot stop. In such cases, stop the WorkUnit, then re-execute this command.
Forced stop stops the transaction system regardless of whether the WorkUnit is active or inactive. The
active WorkUnit is forcibly stopped.
The option for this command is as follows:
-M systemname
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-c
Specifies forced stop. If this option is omitted, normal stop is assumed.
12-18
tdstop
Notes
•
Only system administrators are authorized to execute this command.
•
The command cannot be used with the tdsetup and tdunsetup commands.
•
This command can only be issued after the transaction system has started.
•
Jobs systems started by the Interstage setup command or Interstage operation tools cannot be
stopped by this command.
Example
Tdstop
12-19
Chapter 12: Component Transaction Service Operation Commands
tdtransfer
Name
tdtransfer
Transfers and displays attribute information.
Synopsis
tdtransfer {-p dpcfpath[-i[id1[id2]...[idn]]]
[-c rildname] [-f pildname] [-v rilvseri]
[-w pilvseri] [-m|-d]|-l [id1[id2]...[idn]]}
Description
This command transfers and displays attribute information.
The attribute information extracted by the TD compiler is transferred to NETSTAGE/partner.
NETSTAGE/partner creates partner attribute information, and record information based on the attribute
information. To store both types of information in the partner attribute information library and record
information library, specify the dataset name and volume serial number.
Refer to the OS IV NETSTAGE/Partner Handbook for details of partner attribute information and record
information.
Attribute information is output to standard output. Items of attribute output information are as shown in
Table 12-1.
Table 12-1 Attribute Output Information
12-20
Item name
Display value
Meaning
MODULE-NAME
Module name
Module name
INTERFACE-NAME
Interface name
Interface name
OPERATION-NAME
Operation name
Operation name
INATTRIB
Attribute information name
Input attribute information name
OUTATTRIB
Attribute information name
Output attribute information name
REGISTERED-DATE
YYYY/MM/DD
TD compilation date
TIME
HH:MM:SS
TD compilation time
ITEM-NUMBER
Number
Item belonging to applicable attribute information
NO
Number
Sequence number
NAME
parameter name
Parameter name
KIND
NORMAL
Normal item for hierarchical level
tdtransfer
Item name
Display value
Meaning
ITEM-FORM
V
Attribute for input-output item
S
C
9
X
N
M
TYPE
FIXED
Fixed length of item section
LENGTH1
Number
Number of digits in integer part of numeric data
LENGTH2
Number
Number of digits in integer part of numeric data
The options and operands of this command are as follows:
-p dpcfpath
Specifies the DPCF communication pathname used to transmit attribute information to
NETSTAGE/partner. To transmit attribute information, specify the pathname.
-i [id1[id2]...[idn]]
Specifies the name of the attribute information (id1 to idn) to be transferred. This option can specify
multiple attribute information names. If this option is omitted, all attribute information is transferred.
-c rildname
Specifies the dataset name of the record information library (in rildname) that transfers attribute
information to NETSTAGE/partner. If this option is omitted, the NETSTAGE/partner definition is followed.
-f pildname
Specifies the dataset name of the partner attribute information library (in pildname) that transfers
attribute information to NETSTAGE/partner. If this option is omitted, the NETSTAGE/partner definition is
followed.
-v rilvseri
Specifies the volume serial number of the work record information library (in rilvseri) that transfers
attribute information to NETSTAGE/partner. If this option is omitted, the NETSTAGE/partner definition is
followed.
-w pilvseri
Specifies the volume serial number of the partner attribute information library (in pilvseri) that transfers
attribute information to NETSTAGE/partner. If this option is omitted, the NETSTAGE/partner definition is
followed.
-m
Transfers attribute information for message files. This option cannot be specified with the -d option. If
the -m and -d options are omitted, the -d option is assumed.
12-21
Chapter 12: Component Transaction Service Operation Commands
-d
Transfers attribute information for presentation files. This option cannot be specified with the -m option.
If the -m and -d options are omitted, the -d option is assumed.
-l [id1[id2]...[idn]]
Specifies the name (id1 to idn) of the attribute information to be displayed. This option can specify
multiple attribute information names. If attribute information names are omitted, all attribute information
is displayed. If this option is specified with any other option, an error occurs.
Notes
•
Only system administrators are authorized to execute this command.
•
To execute this command, the following actions must be taken:
−
An IDCM DPCF communication path for TCP/IP communication must be established.
−
The NETSTAGE/partner linked during tdtransfer command execution must be started.
Refer to the IDCM Help for details of how to establish the DPCF communication path. Refer to the OS
IV NETSTAGE/Partner Handbook for details of the NETSTAGE/partner linked during tdtransfer
command execution.
Examples
To transfer attribute information:
tdtransfer -p AEXIDCM1 -i TDFORM01 -c F3233.RECORD -f F3233.LIB
-v VOL001 -w VOL002
To display attribute information:
tdtransfer -l TDFORM01
attribute information
MODULE-NAME
==> MODULE1
INTERFACE-NAME ==> INT1
OPERATION-NAME ==> ALL101
INATTRIB
==> TDFORM01
REGISTERED-DATE ==> 1998/02/24
TIME ==> 18:47:11
ITEM-NUMBER ==> 17
No
NAME
KIND
ITEM-FORM TYPE
LENGTH1
LENGTH2
1
AIM11 NORMAL X FIXED
1
2
AIM12 NORMAL M FIXED
1
-
12-22
tdunsetup
tdunsetup
Name
tdunsetup
Deletes the TD operating environment
Synopsis
tdunsetup
Description
This command deletes the Component Transaction Service operating environment. Execute this
command before uninstalling Interstage.
Notes
•
Only system administrators are authorized to execute this command.
•
This command cannot be executed in the following circumstances:
−
When the TD is running
−
When the tdsetup command is executing
−
When the tdunsetup command is executing
−
When the tdadddef/tddeldef command is executing
•
Uninstallation fails if the operating environment of the Component Transaction Service created by
the tdsetup command is not deleted by this command before uninstalling Interstage.
•
This command is only available in the default system.
Example
tdunsetup
12-23
Chapter 12: Component Transaction Service Operation Commands
12-24
Chapter 13
Database Linkage Service Operation
Commands
This chapter details the Database Linkage Service operation commands.
Note
The Database Linkage Service operation command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Plus.
13-1
Chapter 13: Database Linkage Service Operation Commands
otsalive
Name
otsalive
Outputs Database Linkage Service and resource control program information.
Synopsis
otsalive
escription
This command outputs information about the following applications running on the machine on which it
was executed:
•
OTS system
•
Resource Manager
Examples
Outputs operating information for the Database Linkage Service system and resource control program
(when it is running).
# otsalive
----------------------------------------------------------------OTS system
START-TIME 2000/05/27 16:23:14
OTS Resource
RESOURCE1
START-TIME 2000/05/27 16:24:56
JTS Resource
JTSRMP
START-TIME 2000/05/27 16:24:59
----------------------------------------------------------------Outputs Database Linkage Service system operating information and resource control program (when it
is not running).
# otsalive
----------------------------------------------------------------Nothing
-----------------------------------------------------------------
13-2
otsalive
Notes
•
Only system administrators are authorized to execute this command.
•
"JTSRMP" refers to a resource management command for JTS.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
13-3
Chapter 13: Database Linkage Service Operation Commands
otsmklog
Name
otsmklog
Sets the maximum number of Database Linkage Service transactions and creates the system log file.
Synopsis
otsmklog -l path of system logfile
Description
Usually, this command does not need to be executed because a system log file can be created with the
otssetup command. Use the otsmklog command in the following cases:
•
When data is exported to another environment by using a backup/restore command (because
system log files cannot be processed using the backup/restore command).
•
When a logfile was destroyed
Usually, use the otssetup command in such a case.
Execute the otsmklog command on a machine on which the OTS system can run.
When an option is omitted, a system log file is created by the path name specified to be "OTS path for
system" for an Interstage operation environmental definition, or "LOGFILE" for a setup information file.
The options of this command are as follows:
-l path of system logfile
As a system log file, the maximum length of a path name who can specify is 255 bytes, and he specifies
a ordinary file name. In this case, it specifies in the form of a “Drive name:\Path name.”
Ordinary file names are any file names which do not exist.
As a system log file, the maximum length of a path name it can specify is 255 bytes, and this specifies a
disk partition.
13-4
otsmklog
Notes
•
Only system administrators are authorized to execute this command.
•
Generally, use the otssetup command to create a system log file.
•
File names specified as system log files that contain blank spaces must be enclosed in double
quotation marks (“ ”).
•
When -l option is specified and performed in the environment where the environment of an OTS
system is already built, the system log file specified as -l option becomes effective. Moreover, when
you re-use the system log file created before, please reconstruct an OTS system using either the
isinit or otssetup-o command.
•
The ordinary file specified as a system log file does not need to be created in advance. It is created
by the otsmklog command.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
This command uses shared memory at file creation. Therefore, the machine must be tuned before
this command is executed.
A shared memory of the following size must be prepared for the OTS Participate (specified with the
Interstage operating environment definition), PARTICIPATE (specified with the SETUP information
file), OTS Maximum Transaction (specified with the Interstage operating environment definition), or
TRANMAX (specified with the SETUPT information file):
Z = 1200 + XY + 23.5 X
X : Maximum number of transactions
Y : The number of maximums of the resource that it can participate.
Z : Memory volume (K byte)
•
This command uses shared memory at file creation. Therefore, the machine must be tuned before
this command is executed.
A shared memory of the following size must be prepared for the OTS Participate (specified with the
Interstage operating environment definition), PARTICIPATE (specified with the SETUP information
file), OTS Maximum Transaction (specified with the Interstage operating environment definition), or
TRANMAX (specified with the SETUPT information file):
Z = 3600 + XY
X : Maximum number of transactions
Y : The number of maximums of the resource that it can participate.
Z : Memory volume (K byte)
•
Please compute the required domain size of a disk partition in the following formulas.
The transaction maximum number * P + 1 (K byte)
It asks for P as follows:
When the number of resources which participates in one transaction is four or less:
P=4
When the number of resources which participates in one transaction is five or more:
P = The number of resources which participates.
13-5
Chapter 13: Database Linkage Service Operation Commands
Examples
(1) Creation of a system log file by using the system log file name specified in the previous creation:
otsmklog
(2) Creation of a system log file by specifying a new system log file name:
otsmklog –l D:\ots\logfile
13-6
otsmonitor
otsmonitor
Name
otsmonitor
Monitors the status of an OTS system and resource control program.
Synopsis
(1) This command checks that the OTS system starts up. For this check, set the start time-out period
to 30 seconds and set the monitoring cycle time to 5 seconds as follows.
otsmonitor –t sys –m "startup,timeout=30,cycletime5"
(2) This command checks that a resource control program for OTS starts up. Set the start time-out
period to the default value, and set the monitoring cycle time to the default value as follows.
otsmonitor –t rmp -n resource definition name –m "startup"
(3) This command checks that a resource control program for JTS starts up. Set the start time-out
period to the default value, and set the monitoring cycle time to the default value as follows.
otsmonitor –t rmp -j –m "startup"
(4) This command checks that the OTS system stops.
otsmonitor –t sys –m "terminate"
(5) This command checks that a resource control program for OTS stops.
otsmonitor –t rmp –n Resource definition name –m "terminate"
(6) This command checks that a resource control program for JTS stops.
otsmonitor –t rmp –j –m "terminate"
(7) This command checks that the OTS system starts and then stops.
otsmonitor –t sys –m "startup,terminate"
(8) This command checks that a resource control program starts and then stops.
otsmonitor –t rmp –n Resource definition name –m "startup,terminate"
13-7
Chapter 13: Database Linkage Service Operation Commands
Description
This command monitors the status of the OTS system and a resource control program. This command
can also be used from a cluster system to monitor the OTS system and resource control program.
The options of this command are as follows:
-t sys|rmp
Specify the target to be monitored. When sys is specified, this command monitors the OTS system.
When rmp is specified, this command monitors a resource control program.
-n Resource definition name
Specify the resource definition name. This option must be specified when -t rmp is specified.
-j
Specify to monitor a resource control program for JTS. This option must be specified when -t rmp is
specified.
-m "startup,terminate,timeout=nn,cycletime=mm"
A monitoring operation to be executed can be specified by writing the startup, terminate, timeout, and
cycletime options by delimiting them with an en-size comma (,) and by enclosing these options in ensize double quotation marks (").
startup: Monitor the processing until startup occurs.
terminate: Monitor the processing until stop occurs.
timeout: Set the startup time-out period. If the startup operation is not completed before time-out,
the error is reported and control returns to the command processing. The timeout option does not
affect the terminate option. When the timeout option is omitted, a default value of 60 seconds is set.
A timeout value up to the maximum value (long type) can be specified.
cycletime: Specify the monitoring cycle time in seconds. When the cycletime option is omitted, a
default value of 5 seconds is set. A value up to the maximum value (long type) can be specified.
When the startup option is combined with the terminate option, for example, "startup,terminate", this
command checks processing from startup to stop.
The different return values for this command have the following meanings:
13-8
0:
The monitoring operation is just as specified in -m.
1:
An error was detected during processing.
2:
Startup was not completed within the timeout time of -m.
otsmonitor
Notes
•
Only system administrators are authorized to execute this command.
•
This command does not call otsstart or otsstartrsc, but only executes monitoring processing.
•
If the -m timeout value is less than the cycletime value, the timeout action does not occur until the
cycletime terminates.
Specify the timeout value and cycletime value so that the timeout value is larger than the cycletime
value.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
CORBA Service and Naming Service must be active.
Examples
(1) Monitoring the OTS system.
rem Startup of rem OTS system
otsstart
otsmonitor –t sys –m "startup"
if ERRORLEVEL 0 goto NORMALY_END
if ERRORLEVEL 1 goto ERROR_OCCURRED
if ERRORLEVEL 2 goto TIMEOUT
(2) Monitoring the startup of a resource control program for OTS. Set the startup timeout period to 30
seconds.
rem Monitoring a resource control program for OTS
otsstartrsc –pg c:\temp\ots\resource1.exe –n resource1
otsmonitor –t rmp –n resource1 –m "startup,timeout=30"
if ERRORLEVEL 0 goto NORMALY_END
if ERRORLEVEL 1 goto ERROR_OCCURRED
if ERRORLEVEL 2 goto TIMEOUT
(3) Monitoring the startup of a resource control program for JTS. Set the monitoring cycletime to 2
seconds.
rem Monitoring a resource control program for JTS
otsstartrsc –j
otsmonitor –t rmp –j –m "startup,cycletime=2"
if ERRORLEVEL 0 goto NORMALY_END
if ERRORLEVEL 1 goto ERROR_OCCURRED
if ERRORLEVEL 2 goto TIMEOUT
13-9
Chapter 13: Database Linkage Service Operation Commands
otspendlist
Name
otspendlist
Collects transactions in the in-doubt state.
Synopsis
otspendlist {-s
|
–n resource-definition-name }
Description
This command collects unresolved transactions on the Resource Manager.
The options of this command are as follows:
-s
Display a list of the unsolved transactions on the OTS system. To execute this command, the OTS
system must be operating.
-n Resource definition name
Display a list of the unsolved transactions of the resource control program that was started using a
specified resource definition name. To execute this command, the related databases and resource
control program must be operating.
To resolve unresolved transactions on the Resource Manager, compare the unresolved transaction lists
on both the Database Linkage Service system and Resource Manager.
Then determine the commit or rollback operation on the Resource Manager, as shown in Table 13-1.
Determine the correct operation because a conflict may occur in the database if rollback operation is
performed when a commit operation is required.
Table 13-1 Resource Manager Commit/Rollback Operations
Some unresolved transaction found on Database Linkage
Service system?
Operation on Resource Manager
Yes
commit
No
rollback
Subcommands
The subcommands of the otspendlist command are as follows:
info
The info subcommand displays a list of transactions being processed.
The output items are as follows:
13-10
otspendlist
No
Transaction list number
Transaction-ID
Identifier assigned to each transaction
Status
Status of the transaction after collection. One of the following statuses is displayed:
Committed:
Committed
Rollback:
Rolled back
Deleted:
Deleted
No display:
No transaction collection is performed
Result
Result of transaction collection. One of the following results are displayed:
Successful collection
Normal
Unsuccessful collection
Error
No display
No transaction collection is performed
commit n [, n1,...]
The commit subcommand commits the transaction specified by n. Substitute a number displayed in the
transaction list for n. All transactions can be committed by specifying “all” for n.
This subcommand can be used when a list of unresolved transactions on the Resource Manager is
displayed.
rollback n [, n1,...]
The rollback subcommand rolls back the transaction specified by n. Substitute a value displayed in the
transaction list for n. All transactions can be rolled back by specifying “all” for n.
This subcommand can be used when a list of unresolved transactions on the Resource Manager is
displayed.
delete n [, n1,...]
The delete subcommand deletes the transaction log specified by n. Substitute a value displayed in the
transaction list for n. All transaction logs can be deleted by specifying “all” for n.
This subcommand can be used when a list of unresolved transactions on the Database Linkage Service
system is displayed.
Normally, unresolved transactions on the Database Linkage Service system need not be deleted
because they are deleted when recovery is completed.
Unresolved transactions must be deleted in the following cases:
•
When the related Resource Manager is moved to another host.
•
When the related Resource Manager is deleted.
scroll
The scroll subcommand scrolls the transaction list screen down.
13-11
Chapter 13: Database Linkage Service Operation Commands
save filename
The save subcommand saves the displayed unresolved transaction list in the file specified by filename.
help
The help subcommand outputs a list of the subcommands of the otspendlist command.
quit
The quit subcommand terminates the otspendlist command.
Notes
13-12
•
Only system administrators are authorized to execute this command.
•
When the otspendlist command is used, database mismatching may occur. The system should be
recovered by recovering the network line and restarting the OTS system and resource control
program.
•
When the info subcommand is executed, a transaction list 20 lines long (default) is displayed on the
screen.
To change the number of lines a list displays on the screen, set the environment variable
OTS_SCROLL_SIZE. This variable specifies the number of lines that can be displayed on the
screen for transaction lists displayed by the otstranlist and otspendlist commands.
•
When “all” is specified for the parameter of the commit or rollback subcommand, the subcommand
is executed for all displayed transactions.
•
When specifying a path that includes a blank space in a resource definition file name, enclose the
file name in single quotation marks (‘ ’).
•
When specifying a path that includes a blank in the parameter of the save subcommand, enclose
the subcommand in single quotation marks (‘ ’).
•
The maximum length of the character sequence containing the save subcommand when the save
subcommand is executed is 256.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service must be started.
otspendlist
Example
To output a list of unresolved transactions and rollback all transactions:
otspendlist -n resource1
>info
No Transaction-ID
-- -------------1
a155-d0a1-0abb
2
a156-d0c2-0431
>rollback all
>quit
Status
------
Result
------
13-13
Chapter 13: Database Linkage Service Operation Commands
otssetrsc
Name
otssetrsc
Adds or deletes a Resource Manager.
Synopsis
(1) To add a Resource Manager:
otssetrsc [-a] [-w] [-u UID –g GID] -rf path of resource-definition-filename
(2) Registration of resource control program in overwrite mode:
otssetrsc -o [-w] [-u UID –g GID] -rf path of resource-definition-file
(3) To delete a Resource Manager:
otssetrsc -d -n resource-definition-name
(4) Status reference of Resource Manager:
otssetrsc -l
otssetrsc -l [-n resource definition name]
Description
The otssetrsc command executes the following processing:
•
Registers or deletes a resource control program of the Database Linkage Service to or from the
Implementation Repository of the CORBA Service.
•
Associates a resource control program with the resource definition name specified in the resource
definition file.
The options of this command are as follows:
-a
Adds a Resource Manager.
-w
Sets up a standby system when the cluster environment is set up.
13-14
otssetrsc
-o
Registers a resource control program in overwrite mode. The operation of this option is the same as the
-d option plus the -a option; that is, a resource control program is deleted and then another resource
control program is registered.
-d
Deletes a Resource Manager.
-u UID
Specifies the user name of a database administrator.
When account of the user who started the ObjectTransactionService triggered starting the Resource
Manager becomes effective(OTS only).
When it omits, the user name described by USER of a resource definition file becomes effective. Please
be sure to specify by the option or the resource definition file.
It is necessary to specify it as the -g option simultaneously.
-g GID
Specifies the group name of the database administrator(OTS only).
When it omits, the group name described by GROUP of a resource definition file becomes effective.
Please be sure to specify by the option or the resource definition file.
It is necessary to specify it as the -u option simultaneously.
-rf path of resource definition file
Specifies the name of a resource definition file. Specify the storage destination of the resource definition
file with its full pathname.
-l
Display all the information on the resource definition file assigned to a registered resource control
program. The output information is as follows:
% otssetrsc –l
RESOURCE1
RESOURCE 2
RESOURCE 3
13-15
Chapter 13: Database Linkage Service Operation Commands
% otssetrsc –l
resource1
resource2
resource3
-l –n resource definition name
Display all the information on the resource definition file assigned to a registered resource control
program. This display is made for each resource definition name. The information displayed with this
command is the resource definition file information (specified in the command to register the resource
control program) and the date and time when the resource definition file was registered. The output
information is as follows.
A resource definition file can also be created by redirecting the displayed resource definition information
to a file. This function is useful, for example, if a registered resource definition file is lost.
% otssetrsc –l –n resource1
$ registration time : 2001/03/27 12:04:30
$ VERSION : 4
# Basic Information
NAME=resource1
RSCTYPE=OTS
# DB information
RMNAME=Oracle_XA
OPENINFO=Oracle_XA+Acc=P:///+SesTm=0
CLOSEINFO=
THREADS=FALSE
# Others
OTS_RMP_PROC_CONC=5
Note that the lines marked with $ are automatically added by the system. When an item is omitted, its
default value is displayed
% otssetrsc –l –n resouce1
$ registration time : 2001/03/27 12:04:30
$ VERSION : 4
# Basic Information
NAME=resouce1
RSCTYPE=OTS
# DB information
RMNAME=Oracle_XA
OPENINFO=Oracle_XA+Acc=P:///+SesTm=0
CLOSEINFO=
THREADS=FALSE
USER=user1
GROUP=group1
# Others
OTS_RMP_PROC_CONC=5
13-16
otssetrsc
Note
The line marked with $ is automatically added by the system. When an item is omitted, its default value
is displayed.
Notes
•
Only system administrators are authorized to execute this command.
•
One additional resource control program is started for recovery. Therefore, when
OTS_RMP_PROC_CONC=5 is specified (or this item is omitted) in the resource definition file, six
resource control programs are started in total.
•
File names specified as resource-definitions that contain blank spaces must be enclosed in double
quotation marks (“ ”).
•
Up to 32 resource management programs can be registered.
•
When the CORBA Service is re-installed or re-initialized, the resource management program must
be registered again.
•
When the operating environment for the CORBA Service is set using the odadmin_ex command
after a resource control program is registered, the previously registered information is invalidated.
Delete the registered information by using "otssetrsc -d -n," or register the information again by
using "otssetrsc -o -rf."
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service must be started.
•
When the operating environment for the CORBA Service is set using the odadmin command after a
resource control program is registered, the previously registered information is invalidated. Delete
the registered information by using "otssetrsc -d -n," or register the information again by using
"otssetrsc -o -rf."
•
The resource management program for JTS is not enabled by specifying the -u and -g options. The
resource management program for JTS always required the super user permission.
Examples
(1) To register a Resource Manager:
otssetrsc
-a -rf c:\temp\ots\resource1
(2) To register a Resource Manager in overwrite mode:
otssetrsc
-o -rf c:\temp\ots\resource1
13-17
Chapter 13: Database Linkage Service Operation Commands
(3) To delete a Resource Manager:
otssetrsc
-d -n resource1
(4) To reference a specific resource control program that is already registered:
otssetrsc
-l -n resource1
% otssetrsc –l –n resource1
$ registration time : 2001/03/27 12:04:30
$ VERSION : 4
# Basic Information
NAME=resource1
RSCTYPE=OTS
# DB information
RMNAME=Oracle_XA
OPENINFO=Oracle_XA+Acc=P:///+SesTm=0
CLOSEINFO=
THREADS=FALSE
# Others
OTS_RMP_PROC_CONC=5
(5) When referring to the already registered Resource definition name:
otssetrsc -l
resource1
resource2
resource3
13-18
otssetup
otssetup
Name
otssetup
Operating environment setup of Database Linkage Service system.
Synopsis
otssetup
{{[-a] –f setup-definition-information-file} | -c} [-w] -l | -d
Description
This command executes the following processes:
•
OTS system operating environment in Implementation Repository, Naming Service and Interface
Repository Service.
•
Creates a system log file (only on the machine used for starting the OTS system).
This command can be executed on all machines that use the OTS system.
The options of this command are as follows.
Any of the -a, -w, -l, -d, and -c options can be specified to specify an operation. If none of these options
is specified, it is assumed that the -a option is specified.
-a
Set the environment for OTS operation.
-c
Change the system information when the system is changed from an old environment. For an
explanation of movement from an old environment, refer to the Distributed Application Development
Guide (Database Linkage Service Edition).
-w
Set the standby system when a cluster environment is set.
-f setup-information-definition-file
Specify the path to a setup information definition file. For details of the setup information definition file,
refer to the Tuning Guide.
-l
Reference the setup information.
-d
Used to delete the registered environment.
13-19
Chapter 13: Database Linkage Service Operation Commands
Notes
•
Only system administrators are authorized to execute this command.
•
It is necessary to delete the Database Linkage Service system operating environment using the -d
option during the uninstalling.
•
If after creating the Database Linkage Service system operating environment, the CORBA Service
operating environment has been reset with the odadmin_ex command, reset the Database Linkage
Service system operating environment with this command.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
It is necessary to start the CORBA Service, Naming Service and Interface Repository Service.
•
If after creating the Database Linkage Service system operating environment, the CORBA Service
operating environment has been reset with the odadmin command, reset the Database Linkage
Service system operating environment with this command.
Examples
Register the Database Linkage Service system operating environment
otssetup -a –f c:\temp\ots\setup_info.def
Register a cluster environment in standby node
otssetup -a –w -f c:\temp\ots\setup_info.def
Delete the Database Linkage Service system operating environment
otssetup –d
Change an environment (from old environment only)
otssetup –c
13-20
otsstart
otsstart
Name
otsstart
Starts the Database Linkage Service system.
Synopsis
otsstart
Description
This command starts the Database Linkage Service system. Execute this command on the machine on
which the Database Linkage Service system is to be operated. Start only one Database Linkage Service
system in a network.
Notes
•
Only system administrators are authorized to execute this command.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service and Naming Service must be started.
Example
To start the Database Linkage Service system:
Otsstart
13-21
Chapter 13: Database Linkage Service Operation Commands
otsstartrsc
Name
otsstartrsc
Starts the resource management program.
Synopsis
otsstartrsc {-pg resource-management-program-path-name
definition-name} | -j
-n resource-
Description
This command starts the resource management program. Execute this command on the machine on
which the resource management program is to be operated.
The arguments for this command are as follows:
-pg resource-control-program-path
Specify the full path to the OTS resource control program to be started.
-n resource-definition-name
Specify the name of a resource definition in which information about an OTS resource control program
to be started is described.
-j
Start a resource control program for JTS.
The resource control program that the system supplies is used as the resource control program for JTS.
When a resource control program for JTS is started by using this option, all JTS resource definition files
among the resource definition files registered with the otssetrsc command are automatically applied.
Therefore, resource control programs and resource definition names need not be specified.
Notes
13-22
•
Only system administrators are authorized to execute this command.
•
The Database must be started.
•
Path names specified as resource-management-programs that contain blank spaces must be
enclosed in double quotation marks (“ ”).
•
As for the limitation of the length of a file name to specify as a command argument, a resource
management file name is up to 255 bytes.
•
The resource control program for OTS must be started before the server application is started.
otsstartrsc
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service and Naming Service must be started.
Examples
To start the resource management program for OTS:
otsstartrsc –pg C:\temp\ots\resource1.exe –n resource1
To start the resource management program for JTS:
otsstartrsc –j
13-23
Chapter 13: Database Linkage Service Operation Commands
otsstop
Name
otsstop
Stops the Database Linkage Service system.
Synopsis
otsstop
[-f]
Description
This command stops the Database Linkage Service system. Execute this command on the machine on
which the Database Linkage Service system is to be operated.
There are two modes to stop Database Linkage Service system:
•
Normal stop
•
Forced stop
In normal stop mode, the operation mode of the Database Linkage Service system changed to the
inhibited state. In the inhibited state, new transactions are not accepted, and only termination
processing (commit or rollback) for the transactions being processed is accepted.
The Database Linkage Service system is automatically terminated when all transactions are completed.
When a request to start a new transaction is issued in the system inhibited state, exception information
is reported to the source of the transaction start request.
In forced stop mode, the Database Linkage Service system is forcibly stopped during transaction
processing.
When the Database Linkage Service system and Resource Manager stopped in forced stop mode are
restarted, recovery processing can be performed.
The option of this command is as follows:
-f
Specifies forced stop. If this option is omitted, normal stop mode is assumed.
Notes
13-24
•
Only system administrators are authorized to execute this command.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
otsstop
•
The CORBA Service and Naming Service must be started.
Examples
To normally stop the Database Linkage Service system
Otsstop
To forcibly stop the Database Linkage Service system
otsstop –f
13-25
Chapter 13: Database Linkage Service Operation Commands
otsstoprsc
Name
otsstoprsc
Stops the resource management program.
Synopsis
(1) Stopping a resource control program for OTS:
otsstoprsc
[-f] –n resource-definition-name
(2) Stopping a resource control program for JTS:
otsstoprsc
[-f] –j
Description
This command stops the resource management program. Execute this command on the machine on
which the resource management program is to be operated.
There are two modes to stop the resource management program:
•
Normal stop
•
Forced stop
In normal stop mode, the operation mode of the Database Linkage Service system is changed to the
inhibited state. In the inhibited state, new transactions are not accepted, and only termination
processing (commit or rollback) for the transactions being processed is accepted.
The resource management program is automatically terminated when all transactions are completed.
When a request to start a new transaction is issued in the system inhibited state, exception information
is reported to the source of the transaction start request.
In forced stop mode, the resource management program is forcibly stopped during transaction
processing.
When the resource management program stopped in forced stop mode is restarted, recovery
processing can be performed.
The options and arguments of this command are as follows:
-f
Specifies forced stop. If this option is omitted, normal stop mode is assumed.
-n resource-definition-name
Stops a resource control program for OTS. Specify the name of the resource-definition to set the
resource management.
13-26
otsstoprsc
-j
Stops a resource control program for JTS.
Notes
•
Only system administrators are authorized to execute this command.
•
File names specified as resource-definition-files that contain blank spaces must be enclosed in
double quotation marks (“ ”).
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service and Naming Service must be started.
Examples
(1) To normally stop the resource management program (Specify the resource definition name
assigned to the resource control program):
otsstoprsc –n resource1
(2) To forcibly stop the resource management program (Specify the resource definition name assigned
to the resource control program):
otsstoprsc –f –n resource1
(3) To normally stop a resource control program for JTS:
otsstoprsc –j
(4) To forcibly stop a resource control program for JTS:
otsstoprsc –f –j
13-27
Chapter 13: Database Linkage Service Operation Commands
otstranlist
Name
otstranlist
Manages transaction status.
Synopsis
otstranlist
Description
This command manages the status of transactions being processed, and outputs a list of the
transactions being executed. Execute this command while the Database Linkage Service system is
running.
The user performs commit or rollback for the output transaction list.
The subcommands of the otstranlist command are as follows:
info [-tampicr]
The info subcommand displays a list of the transactions being processed. The output items are as
follows:
No
Transaction list number
Transaction-ID
An identifier assigned to each transaction
Status
Transaction status (get_status information). One of the following statuses is displayed:
13-28
Active:
Being executed
MarkRB:
Marked rollback
Prepared:
Prepared
Unknown:
Unknown
Preparing:
Being prepared
Committing:
Being committed
Committed:
Committed
RingBack:
Being rolled back
RollBack
RollBack complete
otstranlist
Result
Result of the transaction operation. One of the following results are displayed:
successful operation:
Normal
unsuccessful operation:
Error
No display:
No transaction operation is
performed
Start
Transaction start time (24-hour format)
Timeout
Transaction time-out value (set_timeout information)
-t
All transactions are displayed. (Default)
-a
The transaction under execution is displayed.
-m
The transaction marked on the rollback is displayed.
-p
The Pripeae transaction displays it.
-i
The transaction in Pripeae is displayed.
-c
The transaction under committing is displayed.
-r
The transaction in the rollback is displayed.
commit n [, n1,...]
The transaction specified by “n” is committed. “No” displayed by the list of transactions is specified to be
“n”. Moreover, all transactions can be committed by specifying “all” to be “n.”
rollback n [, n1,...]
The transaction specified by “n” is rolled back. The value displayed by “No” of a list is specified to be “n.”
Moreover, all transactions can be rolled back by specifying “all” to be “n.”
scroll
A transaction list screen is lower-scrolled.
save filename
It is kept in the file that a transaction list during the indication was specified with filename.
help
The sub command list of otstranlist commands is output.
13-29
Chapter 13: Database Linkage Service Operation Commands
quit
otstranlist command is ended.
Notes
•
Only system administrators are authorized to execute this command.
•
When the info subcommand is executed, a transaction list 20 lines long (default) is displayed on the
screen.
To change the number of lines of a list displayed on the screen, set the environment variable
OTS_SCROLL_SIZE. This variable specifies the number of lines that can be displayed on the
screen for transaction lists displayed by the otstranlist and otspendlist commands.
•
When “all” is specified for the parameter of the commit or rollback subcommand, the subcommand
is executed for all displayed transactions.
•
When specifying a path that includes a blank space in the parameter of save subcommand,
enclose the subcommand in single quotation marks (‘ ’).
•
The input line of the sub-command is limited to 256 characters with the terminal.
•
The Database Linkage Service (service name: ObjectTransactionService) and CORBA Service
(service name: OD_start, Naming Service) must be active before this command is executed. If
they are not active, enter this command after manually activating these services.
•
The CORBA Service must be started.
Example
To output a list of transactions being executed, and rollback transaction number 1:
otstranlist
>info
No
-1
2
Transaction-ID
-------------a155d0a10abb
a156d0c20431
>rollback 1
>quit
13-30
Status
-----active
active
Result
------
Start-Time
---------20:24:11
20:40:05
Timeout
------0
60
Chapter 14
CORBA Service Operation Commands
This chapter details the CORBA Service operation commands.
Note
The CORBA Service operation command can be used in the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
•
Interstage Application Server Web-J Edition.
In the Web-J Edition, only the following commands can be used:
−
K00stopod
−
OD_kill
−
OD_stop
−
S99startod
−
odsethost
14-1
Chapter 14 : CORBA Service Operation Commands
CosNaming_s
Name
CosNaming_s
Starts the Naming Service.
Synopsis
CosNaming_s [-M system]
Description
This command starts the Naming Service. Any successful application inquiry results in the located
registered object reference being returned to the application.
The options and arguments of this command are as follows.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
CosNaming_s is a service start command for Solaris OE and Linux systems.
Choose the following service from the service screen ([Control Panel]-[Service]), and operate it in
case of Windows NT®/Windows® 2000.
Naming Service : “Naming Service” service
•
Set the following environment variable (if not already set) before executing this command:
OD_HOME: Package storage directory for CORBA Service
14-2
•
Only system administrators are authorized to execute this command.
•
If character set conversion of binding names is used, set the OD_CODE_SET environment variable
to the code type specified by the odadmin command.
CosNaming_s
Example
CosNaming_s &
14-3
Chapter 14 : CORBA Service Operation Commands
InterfaceRep_Cache_s
Name
InterfaceRep_Cache_s
Starts the Interface Repository service (standard interface).
Synopsis
InterfaceRep_Cache_s [-M system]
Description
The InterfaceRep_Cache_s command starts the Interface Repository service for a standard interface.
The CORBA Service must be running before starting the Interface Repository cache service.
The options and arguments of this command are as follows.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
InterfaceRep_Cache_s is the command for starting the service from Solaris OE.
To run this service under Windows NT®/Windows® 2000, select Services from the control panel,
then select the following service from the Services screen:
“InterfaceRep_Cache Service” service
•
Set the following environment variable (if not already set) before executing this command:
OD_HOME: Package storage directory for CORBA Service
14-4
•
Only system administrators are authorized to execute this command.
•
If the value interface was selected in the interface repository service environment settings, use
InterfaceRep_Cache_e. Refer to the odadmin command for information concerning the value
interface. If the standard interface was selected, use this command.
InterfaceRep_Cache_s
Messages
The following messages are displayed during activation.
(Nothing displayed)
[Normal]
The interface information to be loaded is not registered in the database.
InterfaceRepository cache service is activated.
Nowloading
[Normal]
The InterfaceRepository cache server is activated. The registered interface information is now loading to
memory from the database.
Completely loaded
[Normal][Abnormal]
Interface information is completely loaded.
This message is displayed even if the loading process fails.
InterfaceRepository_Err ObjectFile might not be working normally.Please confirm ObjectFile
environment
[Abnormal]
Loading failed, but the cache server was started.
Possible causes are as follows:
Insufficient cache memory
The registered Interface Repository is invalid.
When a new database is structured, first delete the registered Interface Repository and then re-register
a new one.
Note 1: The underlined part of the message is the selected database name.
Note 2: The InterfaceRepository_Err message may be displayed twice.
WARNING: Database destroyed
[Abnormal]
The database was destroyed when a shutdown or similar occurred during transaction processing.
Restore the CORBA Service resource file and database from the backup files.
Exceptions due to errors in the environment setup and their countermeasures are described below.
Exception code:
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Cause
Possible causes may be as follows:
14-5
Chapter 14 : CORBA Service Operation Commands
The database is not restored, or does not exist.
Measures
Create or restore the database.
Exception code:
IDL:CORBA/StExcep/NO_RESOURCES:1.0
Cause
InterfaceRepository cache server may have been started twice.
Measures
Terminate the CORBA Service. Confirm that the InterfaceRepository cache server is terminated, and
then restart the CORBA Service and the Interface Repository.
Exception code:
IDL:CORBA/StExcep/UNKNOWN:1.0
Cause
The CORBA Service is not started.
Measures
Start the CORBA Service.
Exception code:
IDL:CORBA/StExcep/COMM_FAILURE:1.0
Cause
Possible causes are as follows:
a)
The Interface Repository process did not complete within the period_receive_timeout setting (the
default value is 60 seconds) in the $OD_HOME/etc/config file.
b)
LAN error
Measures
a)
Increase the period_receive_timeout value in the config file.
b)
Resolve all LAN environment problems.
Example
InterfaceRep_Cache_s
14-6
InterfaceRep_Cache_e
InterfaceRep_Cache_e
Name
InterfaceRep_Cache_e
Starts the Interface Repository service (value interface).
Synopsis
InterfaceRep_Cache_e
[-M system]
Description
The InterfaceRep_Cache_e command starts the Interface Repository service for a value interface.
The CORBA Service must be running before starting the Interface Repository cache service.
The options and arguments of this command are as follows.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
InterfaceRep_Cache_e is the command for starting the service from Solaris OE.
To run this service under Windows NT®/Windows® 2000, select Services from the control panel,
then select the following service from the Services screen:
“InterfaceRep_e Service” service
•
Set the following environment variable (if not already set) before executing this command:
OD_HOME: Package storage directory for CORBA Service
•
Only system administrators are authorized to execute this command.
•
If the value interface was selected in the interface repository service environment settings, use this
command. Refer to the odadmin command for information concerning the value interface. If the
standard interface was selected, use the InterfaceRep_Cache_s command.
14-7
Chapter 14 : CORBA Service Operation Commands
Messages
The following messages are displayed during activation.
(Nothing displayed)
[Normal]
The interface information to be loaded is not registered in the database.
InterfaceRepository cache service is activated.
Nowloading
[Normal]
The InterfaceRepository cache server is activated. The registered interface information is now loading to
memory from the database.
Completely loaded
[Normal][Abnormal]
Interface information is completely loaded.
This message is displayed even if the loading process fails.
InterfaceRepository_Err ObjectFile might not be working normally.Please confirm ObjectFile
environment
[Abnormal]
Loading failed, but the cache server was started.
Possible causes are as follows:
Insufficient cache memory
The registered Interface Repository is invalid.
When a new database is structured, first delete the registered Interface Repository and then re-register
a new one.
Note 1: The underlined part of the message is the selected database name.
Note 2: The InterfaceRepository_Err message may be displayed twice.
WARNING: Database destroyed
[Abnormal]
The database was destroyed when a shutdown or similar occurred during transaction processing.
Restore the CORBA Service resource file and database from the backup files.
Exceptions due to errors in the environment setup and their countermeasures are described below.
Exception code:
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
14-8
InterfaceRep_Cache_e
Cause
Possible causes may be as follows:
The database is not restored, or does not exist.
Measures
Create or restore the database.
Exception code:
IDL:CORBA/StExcep/NO_RESOURCES:1.0
Cause
InterfaceRepository cache server may have been started twice.
Measures
Terminate the CORBA Service. Confirm that the InterfaceRepository cache server is terminated, and
then restart the CORBA Service and the Interface Repository.
Exception code:
IDL:CORBA/StExcep/UNKNOWN:1.0
Cause
The CORBA Service is not started.
Measures
Start the CORBA Service.
Exception code:
IDL:CORBA/StExcep/COMM_FAILURE:1.0
Cause
Possible causes are as follows:
a)
The Interface Repository process did not complete within the period_receive_timeout setting (the
default value is 60 seconds) in the $OD_HOME/etc/config file.
b)
LAN error
Measures
a)
Increase the period_receive_timeout value in the config file.
b)
Resolve all LAN environment problems.
Example
InterfaceRep_Cache_e
14-9
Chapter 14 : CORBA Service Operation Commands
K00stopod
Name
K00stopod
Terminates the CORBA Service.
Synopsis
K00stopod
Description
The K00stopod command terminates the CORBA Service server and the client application under
operation, and terminates all CORBA Services.
/etc/rc0.d/K00stopod is executed when the system is shutdown.
The K00stopod command terminates the CORBA application under operation, and terminates all
CORBA Services.
This command is stored as follows and started as a shutdown script for the system.
/etc/rc0.d
/etc/rc.d/rc0.d
Note
The above command is a command for the service start with Solaris OE.
Choose the following service from the service screen ([Control Panel]-[Service]), and operate it in case
of Windows NT®/Windows ® 2000.
CORBA Service : “OD_start” service
14-10
OD_impl_inst
OD_impl_inst
Name
OD_impl_inst
This command is used to register and delete a server application, and to display server application
information.
Synopsis
1.
To register a server application
OD_impl_inst -a -r ImplID [-t Type] [-f filename] [-u uid] [-g gid] [-M
system]
OD_impl_inst -ax defname [-M system]
2.
To delete a server application
OD_impl_inst
3.
-d
-r ImplID
[-M system]
To display the contents of server application registration
OD_impl_inst
-p
-r ImplID
[-M system]
Description
This command registers and deletes server application information (pathname and type), in or from an
Implementation Repository, and displays server application information.
The options and arguments of this command are as follows.
-a
This parameter specifies that the command registers a server application in an Implementation
Repository.
-ax defname
This parameter specifies that the command registers a server application in an Implementation
Repository, using definition information in the definition file specified by defname. Refer to Registration
Using a Definition File, below, for the definition file format.
-d
This parameter specifies that the command deletes a server application from an Implementation
Repository.
-p
This parameter specifies that the command displays the server application information registered in a
specified Implementation Repository.
14-11
Chapter 14 : CORBA Service Operation Commands
-r ImplID
This parameter specifies the Implementation Repository ID of the target server application. The ID to be
specified in ImplID must be a string of up to 255 characters, and unique in the system. Refer to Note 2.
-t Type
This parameter specifies the server application activation type.
The following types can be specified:
S (shared):
The server application shares multiple objects.
U (unshared):
One object in the server application is always active.
P (persistent):
The server application is activated by a method that is not related to the CORBA Service.
For instance, when the user starts a server application from the command line, for a CORBA WorkUnit a
persistent server must be used.
M (server per method):
The server application is activated when requested by a client.
If the server application is developed in Java, “-t P” must be specified. If this parameter is omitted, “-t S”
is assumed.
-f filename
This parameter specifies the pathname for the server application, and must be specified when “-t S”, “-t
U” or “-t M” are specified.
-u uid
Sets the user ID when the server application is run. The default value is 0 (root).
-g gid
Sets the group ID when the server application is run. The default value is 3 (sys).
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Registration Using a Definition File
Tables 14-1 to 14-3 define the format and item settings of the definition file (defname) specified in the ax parameter:
14-12
OD_impl_inst
Table 14-1 Definition File Items and Settings (Windows®)
Item
Value
rep_id
= IDL:test1:1.0
type
= shared
binary
= D:\user\test1_s.exe
param
= -x 100
env
= PATH=D:\user;
IDL:test1/intf1:1.0
IDL:test1/intf2:1.0
:
= D:\user\INTF1.dll
= D:\user\INTF2.dll,,IDL:test1/intf1:1.0
proc_conc_max
= 10
thr_conc_init
=5
thr_conc_maximum
= 30
mode
= COMPATIBLE
iswitch
= OFF
ior
= 1.1
locale
= NONE
ssl
= AUTO
Table 14-2 Definition File Items and Settings (Solaris OE)
Item
Value
rep_id
= IDL:test1:1.0
type
= shared
binary
= /user/test1_s
param
= -x 100
env
= PATH=/user;
uid
=0
gid
=3
IDL:test1/intf1:1.0
IDL:test1/intf2:1.0:
:
= /user/libINTF1.so
= /user/libINTF2.so,,IDL:test1/intf1:1.0
proc_conc_max
= 10
thr_conc_init
=5
14-13
Chapter 14 : CORBA Service Operation Commands
Item
Value
thr_conc_maximum
= 30
mode
= COMPATIBLE
iswitch
= OFF
ior
= 1.1
locale
= NONE
ssl
= AUTO
Table 14-3 Definition File Items and Settings (Linux)
Item
Value
rep_id
= IDL:test1:1.0
type
= shared
binary
= /user/test1_s
param
= -x 100
env
= PATH=/user;
uid
=0
gid
=3
IDL:test1/intf1:1.0
IDL:test1/intf2:1.0:
:
= /user/libINTF1.so
= /user/libINTF2.so,,IDL:test1/intf1:1.0
proc_conc_max
= 10
thr_conc_init
=5
thr_conc_maximum
= 30
mode
= COMPATIBLE
iswitch
= OFF
ior
= 1.1
locale
= NONE
ssl
= AUTO
rep_id
This item specifies the Implementation Repository ID of the server application.
type
The start type of the server application is specified. The following start types can be specified:
shared, unshared, persistent, server_per_method
When the development language is JAVA, specify "persistent".
14-14
OD_impl_inst
For an application that uses WorkUnits, specify "persistent".
binary
This item specifies the pathname for the server application. This item must be specified for all servers
except “persistent” servers.
param
This item specifies the activation parameter for the server application.
This item is invalid when “type = persistent” is specified. If omitted, “no parameter” is assumed.
env
This item specifies the environment variables for executing the server application. This item is invalid
when “type = persistent” is specified. Each variable must be delimited by a semicolon (;).
If this item is omitted, the system manager (root) environment is used.
uid
This item specifies the user ID for executing the server application. If omitted, 0 (root) is assumed.
gid
This item specifies the group ID for executing the server application. If omitted, 3 (sys) is assumed.
intfID (optional)
If the server object is created as a library (with the IDLc -dy command) and multiple interfaces are
installed, this item specifies the corresponding Interface Repository ID.
If an interface is inherited, this item also specifies the correspondence to that interface.
14-15
Chapter 14 : CORBA Service Operation Commands
The specification format is as follows:
intflD = [solib][,prefix[,inherit[,..]]]
intfID:
Specifies the Interface Repository ID of the object.
solib:
Specifies the pathname for the library. The default is no library.
prefix:
Specifies “prefix” specified by “IDLc -Sprefix”. (C only). If the server application uses a
dynamic skeleton interface in COBOL, “DSI” must be specified.
inherit:
Specifies the Interface Repository ID to be inherited.
If the -S option is not specified in the IDLc command, “prefix” must be omitted. When multiple Interface
Repository IDs are to be specified, they must be delimited by a comma (,).
proc_conc_max
This item specifies the maximum concurrent number of processes. If omitted, “1” is assumed. Up to 256
can be specified. If more than 256 is specified, 256 is used.
thr_conc_init
This item specifies the initial number of concurrent threads. The available range is from 1 to
2147483647 (maximum value of long). If a value outside the range is specified, or if the value is omitted,
16 is the default value
If in process mode, specify the value “1”.
Note that the number of threads that can actually be activated depends on the OS and memory
resource.
thr_conc_maximum
This parameter specifies the maximum number of concurrent threads. Server threads are automatically
increased to the number specified here. If automatic increase is not to be used, specify the same value
for this parameter as that specified for thr_conc_init.
If this parameter is omitted, the value specified for thr_conc_init is also set for this parameter, and
automatic increase is disabled. The available range is from the value set for thr_conc_init to
2147483647 (maximum value of long). If a value less than that set for thr_conc_init is specified, an
error occurs. If the specified value exceeds 2147483647, the value specified for thr_conc_init is also
used for this parameter.
Note that the number of threads that can actually be activated depends on the OS and memory
resource.
The number of server threads specified here is the number of threads used for request processing. The
server process activates, in addition to these threads, auxiliary threads for process control. For this
reason, when the number of server threads is checked with an OS-provided application or a command,
a value greater than that specified for thr_conc_maximum may be indicated.
mode
This item specifies the operation mode to be set when the server application is activated.
[Activation method (function name is in C)]
C, C++, COBOL, OOCOBOL: CORBA_BOA_impl_is_ready(), CORBA_BOA_obj_is_ready()
Java: org.omg.PortableServer.POAManager.activate().
14-16
OD_impl_inst
The following operation modes can be specified:
COMPATIBLE :
The activation method returns after the server application is activated. (Default)
SYNC_END:
The activation method does not return, even after the server application is activated. Control is returned
when CORBA_BOA_deactive_impl() is issued or the server application is stopped.
Always specify SYNC_END in the following cases:
•
A server application was created in process mode
•
A Java server application was created in thread mode
•
A OOCOBOL server application was created in thread mode
iswitch
This item specifies whether the server application retains instance data for each client application
(specify ON or OFF).
Specify ON to use the Factory mode or user instance management mode for the application mode.
It is invalid when “type = server_per_method” is specified.
This parameter is valid when the development language is CPP, JAVA, or OOCOBOL.
This parameter is valid when the development language is CPP or JAVA.
ior
This item specifies the linkage version. The following versions can be specified. Refer to the
OD_or_adm command for details. For example, “1.0” (old version : optional) , “1.1” (New version)
locale
This item specifies the code type of the object reference, which in turn specifies the code type for the
server application.
This definition can be specified only for ior = 1.1. If locale is not specified in ior = 1.1, implicit value of
code information for the object reference is set. Refer to the OD_set_env command for details.
When the code type is set ("locale"), the code type information is incorporated in the Implementation
Repository ID or the object reference. However, code type settings apply only in systems that handle
multi-byte codes. Do not set code types in other systems.
ssl
When creating a server application Object Reference, specify the rule of adding SSL information.
The following values can be specified:
−
“ON”
Always adds SSL information.
14-17
Chapter 14 : CORBA Service Operation Commands
−
“OFF” (When omitted)
Does not add SSL information. However SSL information is added to the Object Reference
created with the OD_or_adm command –s option.
−
“AUTO”
Decides, by the state of connection with the client application, whether there is SSL
information or not when the Object Reference is generated dynamically.
If SSL communication is to be carried out with the established connection between the server
application and the client application, when a server application generates an Object
Reference dynamically by the calling from a client application, “AUTO” generates the Object
Reference with SSL information.
If SSL communication is not to be carried out, “AUTO” generates the Object Reference without
SSL information.
The following table shows how the specified values of this parameter and static generation (using
the OD_or_adm command and so on) / dynamic generation (using the CORBA_BOA_create
function and so on) of the Object Reference relate to presence and absence of SSL information.
Table 14-4 SSL Parameter Specified Values
How to generate Object Reference
SSL parameter
specification
Static generation
(OD_or_adm etc.)
Dynamic generation
(CORBA_BOA_create function etc.)
SSL specification
(-s)
None
SSL communication is
carried out
SSL communication is
not carried out
"ON"
O
O
O
O
"OFF"
O
X
X
X
X
O
X
"AUTO"
O
O: SSL communication valid
X: SSL communication invalid
If instance data is retained for each client application or the item iswitch specification is ON, the
connections to carry out SSL communication and not to carry out SSL communication cannot be
executed concurrently in the same connection between the client and server applications.
Therefore, in the case where iswitch is specified as ON and a server application generates an
Object Reference dynamically, we recommend you specify “AUTO” for this parameter in order to
avoid different connections.
Notes
14-18
•
When the server application start type is server_per_method, the application is started and stopped
by requests from the client. However, if successive requests are issued from the client, a
No_RESOURCES exception occurs due to the small value of proc_conc_max. Therefore, set an
appropriate value for proc_conc_max.
•
When the -ax option is used to define a server application in the definition file, the maximum length
of a character string that can be specified on one line is 511 bytes (512 bytes including a
termination character).
OD_impl_inst
•
If env and intfID are specified in the definition file, add the value, which is obtained by dividing the
length of the specified character string by 40, to max_impl_rep_entries.
•
Implementation Repository ID and Interface Repository ID
The Implementation Repository ID must be the same as either the Interface Repository ID or
arbitrary character string.
The id specified in the OD_or_adm command –a option must be the same as the arbitrary
character string. Refer to the OD_or_adm command.
Note that the Implementation Repository ID must be registered with the OD_impl_inst command
before executing the OD_or_adm command.
When the Implementation Repository ID is same as the Interface Repository ID, the repository ID
must be the one that identifies a module/interface defined in IDL. The format and items of the
repository ID specification are explained below.
format:identification-information:version
format:”IDL” must be specified.
identification-information:
The module and interface names defined in IDL must be specified, and separated by a slash (/).
version: “1.0”
The version need not be specified, but if it is, “1.0” must be specified.
•
If the relevant Implementation Repository ID has been registered in a queuing policy, the policy
must be deleted by the odsetque command after deleting the application server by the
OD_impl_inst command.
•
If the start type is persistent, start the server application with administrator authority.
•
If the so library start type is other than persistent, specify env = LD_LIBRARY_PATH=(so-librarypath) as a startup environment variable in the definition file.
•
When executing a server application that recursively calls methods (for example when a server
application recursively calls the server’s own methods or when server application A calls another
server application’s method and then calls server application A’s method), set proc_conc_max,
thr_conc_init to a value equal to or greater than the following value:
Set value = (number of recursive calls + 1) x number of client applications
•
If the activation type is other than "persistent," the OS environment variable is invalidated. Specify
the OS environment variable in the env definition in the definition file as needed.
•
If the COBOL application start type is other than persistent, specify env = LANG=ja_JP.U90 as a
startuup environment variable in the definition file. Otherwise, “JMP00291-U” will be displayed.
Messages
The following messages can be displayed at command execution:
14-19
Chapter 14 : CORBA Service Operation Commands
Error:ObjectDirector not running
CORBA Service has not been started.
Error:RepositoryID is already registered.
The specified RepositoryID has already been registered.
Error:RepositoryID is not registered.
The specified RepositoryID has not been registered.
Error:FJ_ImplementationRep_synch
Registration in the Implementation Repository failed. The disk may be full.
Error:RepositoryID delete fails
Deletion from the Implementation Repository failed. The server application having the specified
Implementation Repository ID may be operating.
File not found
The file specified in the -ax option was not found.
Invalid syntax file: line number
A syntax error was found in the line indicated by “number”, in the file indicated by “file.”
Load Error Impl DB
impl.db cannot be loaded.
Multiply XXX
The XXX option definition was duplicated.
Illegal option [XXX]
The specified option does not exist for the command.
RepositoryID is NULL
The parameter with -r option was not specified.
Type is NULL
The parameter with -t option was not specified.
Filename is NULL
The parameter with -f option was not specified.
14-20
OD_impl_inst
Error:FJ_ImplementationRep_create_impl_def
Information on the application server couldn't be registered in Implementation Repository. A conflict may
exist between the ior version and locale information.
Check the definitions file to ensure that the ior version and the locale information do not conflict.
This error message is also posted if a Repository ID that is already registered is specified and the
command is started with –ax specified.
OD_impl_inst:option requires an argument -- X
The X option parameter was not specified. Set the parameter.
DB:proc_conc_max too large
The value of proc_conc_max exceeds available maximum number 256.
14-21
Chapter 14 : CORBA Service Operation Commands
OD_kill
Name
OD_kill
Terminates the CORBA Service forcibly.
Synopsis
OD_kill [-M system]
Description
The OD_kill command forcibly terminates the CORBA Service. It is used to forcibly terminate the
CORBA Service if the CORBA Service system has hung for any reason.
Since the service terminates without releasing the system resources acquired by the CORBA Service,
the resources must be recovered using the ipcrm command.
The options and arguments of this command are as follows.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
The above command is a command for the service start with Solaris OE.
Choose the following service from the service screen ([Control Panel]-[Service]), and operate it in case
of Windows NT®/Windows® 2000.
CORBA Service : “OD_start” service
14-22
OD_or_adm
OD_or_adm
Name
OD_or_adm
Generates and displays object references.
Synopsis
1.
To generate an object reference
OD_or_adm -c IntfID [-a ImplID] [-h HostName -p PortNum] [-s]
[-L Locale|-v version] [-r refdata] -o file [-M system]
OD_or_adm -c IntfID [-a ImplID] [-h HostName -p PortNum] [-s]
[-L Locale|-v version] [-r refdata] -i service [-M system]
OD_or_adm -c IntfID [-a ImplID] [-h HostName -p PortNum] [-s]
[-L Locale|-v version] [-r refdata] -n name [-M system]
2.
To delete an object reference:
OD_or_adm -d -i service [-M system]
OD_or_adm -d -n name [-M system]
3.
To display object references:
OD_or_adm –l [-M system]
4.
To generate the object group:
OD_or_adm [-c IntfID [-a ImplID] [-h HostName -p PortNum]
[-L Locale|-v Version]] -g Group -n name [-M system]
5.
To delete the object group:
OD_or_adm -d -n name [-M system]
6.
To generate the naming context:
OD_or_adm -z name [-u URLname] [-M system]
7.
To delete the naming context:
OD_or_adm -d -z name [-M system]
14-23
Chapter 14 : CORBA Service Operation Commands
Description
This command manages the object reference of the object specified by IntfID, generates a load balance
object group, and registers/deletes the object group to/from the Naming Service.
The options and arguments of this command are as follows:
-c IntfID
This parameter specifies that the command generates an object reference with the Interface Repository
ID specified in IntfID.
A repository ID (a string less than 256 characters) identifying the module or interface information defined
in IDL must be specified as the Interface Repository ID.
The format and items of the repository ID specification are as follows:
format:identification-information:version
format: "IDL" must be specified.
identification-information:
The module and interface names defined in IDL must be specified, and separated by a slash (/).
version: “1.0”
The version need not be specified, unless it is “1.0” which must be specified.
-a ImplID
This parameter specifies an Implementation Repository ID when it must be an identifier other than the
Interface Repository ID.
When the registered Implementation Repository ID is different from the Interface Repository ID, this
parameter must be specified and must be the same as that specified with the OD_impl_inst command –
r option. If this parameter is omitted, the object reference is generated using the same Implementation
Repository ID as the Interface Repository ID. Refer to the OD_impl_inst command for details.
-h HostName
This parameter specifies the name or IP address of the host that receives requests. If omitted, the local
host is set.
-P PortNum
This parameter specifies the number of the port to receive requests.
If omitted, the port number is set to the “IIOP_port” specification in the config file.
-L Locale
Specify the conversion code type of the object reference.
This option cannot be specified with the -v option.
When the code type is set (-L option), the code type information is incorporated in the Implementation
Repository ID or the object reference. However, code type settings apply only in systems that handle
multi-byte codes. Do not set code types in other systems.
-s
This parameter is specified when SSL communication is carried out to add SSL information to the Object
Reference. The SSL encrypted level is based on the SSL environment setup. Refer to the odsetSSL
command.
14-24
OD_or_adm
Even if this parameter is omitted, if the specified value of SSL information has been set to “ON” in
registration of the server application by the OD_impl_inst command, SSL information is added. Refer to
the OD_impl_inst command.
-v version
This is specified when linking with a system running an earlier version. The following version can be
specified:
“1.0” (previous version)
This option cannot be specified with the -L option.
-o file
This parameter specifies that the object reference is generated in character string format and is stored
in the file specified by file.
-r refdata
This parameter specifies the identification information in IOR as a character string. The identification
information is in octet format, but only character string data can be specified with this command.
-i service
This parameter specifies that the generated object reference is registered in the initial service (init.svc)
with the name specified by service.(See Notes)
-n name
The name by which the object is registered in the Naming Service. The naming context can be specified
in levels while registering the object in the Naming Service with the specified name in character string
binding name format. For further information, refer to information on character string binding names in
the Distributed Application Development Guide (CORBA Service Edition). This is provided with
Enterprise Edition and Standard Edition products.
An error is caused if the naming context does not exist.
-z name
Creates a new naming context, and registers with the Naming Service. Specify as a character string
binding name (refer to information on character string binding names in the Distributed Application
Development Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard
Edition products.
The naming context can be specified with the –n option, and must be specified with the full path, and the
starting and terminating characters (“/”). An error occurs if it does not begin or end with “/”.
To recreate the naming context, refer to Note 3. Every host that Naming Service is employed can create
the naming contexts to 128 maximums.
-u URLname
Naming contexts in Naming Services on other hosts can be registered with the binding name specified
in –z name. URLs must be specified in a particular way. Refer to the information on URL schemas in
the Distributed Application Development Guide (CORBA Service Edition). This is provided with
Enterprise Edition and Standard Edition products. Only V3.0 or higher Naming Services can be linked.
When this command is entered, the Naming Service must be registered in the machine in which the
linked Naming Service operates, and the CORBA Service must be operating.
14-25
Chapter 14 : CORBA Service Operation Commands
-d
This parameter specifies that the object reference or naming context will be deleted. An error occurs if
there is an object reference in the naming context.
-l
This parameter specifies that the command displays a list of initial services (registered with the -i option).
-g Group
Specify “lb” to indicate the generating object group for load balance. Specify other information for the
object reference, required while registering the default object reference for LBG in conjunction with other
options.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Initial service (registered by the use of the -i option) is stored in the initial service definition file
(init_svc). Because the init_svc file contains the information that is unique to the server, it cannot
move to the other server straightly. In order to move the resource to other server, the OD_or_adm
command (-i option) must be executed by the destination server. It is recommended to keep the
execution script for the preparation for possible damage of resource.
•
Start the load balance function before performing an operation for the load balance object group.
Delete all objects under the load balancing object group (LBG) before deleting the object group,
however, do not delete the default object.
•
Note the following points concerning manual registration of transaction application objects to the
Naming Service:
−
−
Set the ImplID in accordance with the linkage format, as follows:
If the WorkUnit type is ORB:
FUJITSU-Interstage-TDLC
If the WorkUnit type is WRAPPER:
FUJITSU-Interstage-TDRC
When creating object references:
Host names specified by the -h option and host names set for inithost and hosts must be
specified in lowercase characters.
−
14-26
The names specified by the -n option are object names (module names or interface names
defined in the IDL definitions). Any names can be used, but an object name is mandatory.
Also, when an arbitrary name is to be used, an object name must be specified. To use an
arbitrary name, the following commands must be issued as a pair:
OD_or_adm
Examples:
OD_or_adm -c IDL:tdsample1/INTF:1.0 -a FUJITSU-Interstage-TDLC -n tdsample1::INTF
OD_or_adm -c IDL:tdsample1/INTF:1.0 -a FUJITSU-Interstage-TDLC –n any name
−
If inheritance is used, the interface repository ID specified by the –c option must be the ID of
the Interface Repository that inherits from the inheritance source. If the inheritance source is
specified, the destination for call-outs from the client application cannot be made specific.
−
The Component Transaction Service must be started before this command is executed.
Notes
(1) Code conversion
Interstage version 1.1 onwards supports the code conversion function, and supports the IOR1.0 and
IOR1.1 communications protocols. IOR is an abbreviation of Interoperable Object Reference, and is an
object reference in a network. In version 1.1 of IOR, code conversion is supported.
The method of processing the -L and -v options, added by the code conversion function, is as follows:
1)
2)
When the -v and -L options are not specified together.
Defaults according to the information registered in the Implementation Repository. Refer to the
OD_impl_inst command.
When creating common object references for versions earlier than 1.0 and later than 1.1:
OD_or_adm -c IDL:ODdemo::calculator:1.0 -n ODdemo::calculator -v 1.0
Note that the Code conversion function cannot be used.
3)
When creating an object reference in Interstage version 1.1or later that uses code conversion:
OD_or_adm -c IDL:ODdemo::calculator:1.0 -n ODdemo::calculator -L EUC
The OD_or_adm command cannot be used for V1.0 clients. This object reference cannot be registered
in the Naming Service for version 1.0.
Note that if the h option is used to register an object reference of a different host, the default code
conversion at the specified host cannot be determined. Therefore, -L or the –v option must be used.
(2) Registering object references to a Naming Service
An example of using the OD_or_adm command to register object references and naming contexts to the
Naming Service is shown in Figure 14-1.
Figure 14-1 Registering Object References to the Naming Service
1)
Creating ObjectA
OD_or_adm -c xxx -n ObjectA
14-27
Chapter 14 : CORBA Service Operation Commands
2)
Creating ObjectB
OD_or_adm -z NamingContextA
OD_or_adm -z NamingContextA/NamingContextB
OD_or_adm -c xxx -n NamingContextA/NamingContextB/ObjectB
Multiple object references and naming contexts cannot be created together. If a parent naming context
is created, a child object or naming context must be created.
Messages
The following messages can be displayed at command execution:
Error:CORBA_ORB_init
The CORBA Service has not been started.
Error:CORBA_ORB_resolve_initial_references
Acquisition of initial references failed.
Error:CORBA_ORB_set_initial_service
Registration of the specified service as the initial service failed.
Error:CosNaming_NamingContext_resolve
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_bind
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_bind_new_context
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_unbind
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The Naming Service has not started.
Error:CosNaming_NamingContext_resolve_ObjectGruop
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The Naming Service has not started. (-n option)
Error:delete_initial_service
Deletion of the specified service as the initial service failed.
Error:FJ_ImplementationRep_lookup_id
The specified Implementation Repository ID has not been registered. This message can appear if the -a
option is specified.
Error: admin_synch
Updating the initial_services failed. The object reference has not been registered in the Naming Service.
The file could not be written, or the disk may be full.
14-28
OD_or_adm
Error:CosNaming_NamingContext_bind
id:IDL:CosNaming/NamingContext/AlreadyBound:1.0
Or,
Error:CosNaming_NamingContext_bind_new_context
id:IDL:CosNaming/NamingContext/AlreadyBound:1.0
Failed to register the object, the naming context or object group. The Naming Service is already
registered.
Error:CosNaming_NamingContext_unbind
id:IDL:CosNaming/NamingContext/NotFound:1.0
Failed to delete the object, naming context or object group. The Naming Service is not registered.
Error:CosNaming_NamingContext_resolve
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_bind
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_bind_new_context
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Or,
Error:CosNaming_NamingContext_unbind
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The load balance function was not started for Naming Service or object group.
Can't open file name
The file indicated by name cannot be opened. This message can appear if the -o option is specified.
Can't write
Object references cannot be written in a file. This message can appear if the -o option is specified.
Can't find 'name' in initial_services
The service indicated by name was not found among the initial services.
Error:CosNaming_NamingContext_bind
id:IDL:CosNaming/NamingContext/CannotProceed:1.0
Or,
Error:CosNaming_NamingContext_unbind
id:IDL:CosNaming/NamingContext/CannotProceed:1.0
Processing is disabled because the $OD_HOME/etc/CosNaming directory has insufficient space. This
directory must be moved to a disk partition that has sufficient free space.
14-29
Chapter 14 : CORBA Service Operation Commands
The specified character set is wrong
The specified character set is an invalid code type setting.
Multiply XXX
The definition of option XXX was duplicated.
Illegal option [XXX]
The specified option does not exist.
ReferenceData is NULL
The parameter with the -r option was not specified.
Filename is NULL
The parameter with the -o option was not specified.
Service is NULL
The parameter with the -s option was not specified.
Name is NULL
The parameter with the -n option was not specified.
Host is NULL
The parameter with the -h option was not specified.
Port is NULL
The parameter with the -p option was not specified.
Locale is NULL
The parameter with the -L option was not specified.
Version is NULL
The parameter with the -v option was not specified.
The specified port is wrong
Invalid port number setting.
The specified version is wrong
Invalid version setting.
Specify both [-h host] and [-p port]
[-h host] and [-p port] cannot be specified together.
Character set cannot be specified in version 1.0
Code type cannot be set for version 1.0.
Failed to create Object References
Failed to create object reference.
Failed to get locale information
Failed to retrieve code type.
14-30
OD_or_adm
Error:ISOD_LBO_create_LBG
id: IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The load balance function or Naming Service was not started.
Error:ISOD_LBO_create_LBG
id: IDL:ISOD/LBG/BadObject:1.0
The specified Interface Repository ID is invalid.
Error:ISOD_LBO_create_LBG
id: IDL:ISOD/LBO/AlreadyExist:1.0
The specified object group name is already registered in the Naming Service.
Error:ISOD_LBO_create_LBG
id: IDL:ISOD/LBO/NotFound:1.0
Either the specified object group naming context is not registered, or it is registered as an object or
object group.
Error:CosNaming_NamingContext_resolv_ObjectGroup
Failed to find the object group to be deleted.
Error:ISOD_LBO_delete_LBG
id: IDL:ISOD/LBO/NotEmpty:1.0
More than one object is registered in the object group.
Error:ISOD_LBO_delete_LBG
id: IDL:ISOD/LBO/NO_IMPLEMENT:1.0
The load balance function or Naming Service was not started.
Group is NULL
The parameter of the -g option was not specified.
The specified operand is wrong
Operand specification is invalid.
LB Group Name Failed
The object group name specification is invalid.
Error:CosNaming_NamingContext_destroy
id:IDL:CosNaming/NamingContext/NotEmpty:1.0
An object reference exists in the naming context to be deleted. Delete the object reference, then delete
the naming context.
Error:CosNaming_NamingContext_resolve_ObjectGruop
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
14-31
Chapter 14 : CORBA Service Operation Commands
Error:CORBA-ORB string_to_object
id:IDL:CORBA/StExcep/UNKNOWN:1.0
id:IDL:CORBA/StExcep/COMM_FAILURE:1.0
There is an error in the URL name specified in the –u option. Otherwise, the Naming Service may not
be registered in the machine linked, or the CORBA may not be active.
URLname is NULL
A parameter in the –u option has not been specified.
Example
OD_or_adm –l
ImplementationRepository
(r2d2:8002:1.0:)
FJ_LightInterfaceRepository
(r2d2:8002:1.0:)
FJ_ORB_admin
(r2d2:8002:1.0:)
nill_oref
NameService
(r2d2:8002:1.0:)
FJ_LoadBalancingOption
(r2d2:8002:1.0:)
14-32
IDL:FJ/ImplementationRep:1.0
IDL:FJ/Repository:1.0
IDL:OM_ORB/admin:1.0
IDL:CosNaming/NamingContext:1.0
IDL:ISOD/LBO:1.0
OD_set_env
OD_set_env
Name
OD_set_env
Sets an IP address to be embedded when an object reference is generated.
Synopsis
1.
Setting an IP address or host name:
OD_set_env -n {IPaddress|HostName} [-L Locale] [-M system]
OD_set_env -L Locale [-M system]
2.
Displaying set information:
OD_set_env –l [-M system]
Description
This command runs on the server, and is used to set an IP address to be embedded in the object
reference that is generated.
The options and arguments of this command are as follows:
-n {IPaddress|HostName}
This parameter specifies the IP address or host name of an application server to be set in the object
reference. There is no validity checking of the values specified in IPaddress and HostName. Ensure that
all values specified are valid.
-L Locale
Sets the object reference conversion code.
-l
This parameter displays the information to be embedded in the object reference of the server application.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
14-33
Chapter 14 : CORBA Service Operation Commands
Notes
•
Execute this command with Administrator authority when specifying the -n and -L options
(information setting).
•
In order to validate the set information, the CORBA Service(ObjectDirector) must be restarted.
•
When using this command to set an IP address or host name, the IP address or host name
becomes valid when the object reference for the server is generated.
•
To change the IP address or host name of the object reference used by each Interstage service,
Interstage must be initialized in forced initialization mode by using the isinit command. To initialize
each service without using the isinit command, use the command of each service to re-initialize the
service.
Messages
The following messages can be displayed at command execution:
$OD_HOME is not set
Environment variable “OD_HOME” has not been set.
OD_set_env:option requires an argument -- X
The X option parameter was not specified. Specify the parameter.
ObjectReference create environment error
An error was found in the environment settings.
your unauthorized environment change
You are not authorized to set environmental information.
Multiply XXX
The XXX option definition was duplicated.
locale is NULL
The parameter with the -L option was not specified.
name is NULL
The parameter with the -n option was not specified.
Failed to open boa.env
Failed to open boa.env.
14-34
OD_stop
OD_stop
Name
OD_stop
Terminates the CORBA Service.
Synopsis
OD_stop [-M system]
Description
The OD_stop command releases the system resources acquired by the CORBA Service, then
terminates the CORBA Service.
The options and arguments of this command are as follows.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
•
This command is used for stopping services on the Solaris OE system and Linux system.
•
Choose the following service from the service screen ([Control Panel]-[Service]), and operate it in
case of Windows NT®/Windows® 2000:
CORBA Service : “OD_start” service
14-35
Chapter 14 : CORBA Service Operation Commands
S99startod
Name
S99startod
Starts the CORBA Service
Synopsis
S99startod
Description
The S99startod command starts the CORBA Service.
This command is stored as following and started as a system initialization script.
/etc/rc2.d
/etc/rc.d/rc2.d
Note
The above command is a command for the service start with Solaris OE.
Choose the following service from the service screen ([Control Panel]-[Service]), and operate it in case
of Windows NT®/Windows® 2000.
CORBA Service : “OD_start” service
Messages
The following messages are displayed during command activation and during ObjectDirector operation
(xxx indicates the keywords or size)
Daemon already running
The ObjectDirector is already activated.
Failed to create key:(xxx)
Failed to create shared memory key (See Note 1).
14-36
S99startod
Failed to create shared memory(xxx)
Failed to create shared memory (See Note 1).
Failed to get shared memory(xxx)
Failed to get shared memory (See Note 1).
Failed to attach (xxx)
Failed to attach shared memory (See Note 1).
Failed to create/attach to semaphore set
Failed to create and attach semaphores (See Note 1).
Failed to create/attach to message queue
Failed to create and attach message queues (See Note 1).
Failed to create named pipe
Failed to create a named pipe.
Failed to create key file
Failed to create a key file.
Failed to establish IPC link
Exceeded maximum number of processes (max_processes of config file), or failed to create a pipe.
Failure to open initial service file
Failed to open the initial_services file.
Failure to write to initial service file
Failed to write the initial_services file.
Failed to find entry in /etc/services file for name/type
Entry name/type not found in /etc/services file.
Failed to establish IIOP listen on port number
Failed to fix the socket port number.
Too many open files or Too many files
Too many directories are open in the process. Extend the upper limit of directories with the ulimit
command.
Named pipe error!! ObjectDirector cannot work normally.
An error occurred in the named pipe. The ObjectDirector cannot work normally. The fd limit can be
increased with the ulimit command, and restart.
Pipe cannot be re-bind. Process pid cannot receive requests any more.
Failed to reconnect the pipe in pid. The upper limit of the number of fd can be increased. Either increase
the count with the ulimit command and restart the process or terminate unnecessary clients.
Failed to create log file
Failed to create a log file.
14-37
Chapter 14 : CORBA Service Operation Commands
Failed to create/open log pipe
Failed to create and open a log pipe.
log level is log_level
Shows the log level log_level (displays only when log settings are ON).
Invalid config file line, number
An error has occurred at the line number specified in the config file.
invalid keyword xxx
Invalid keyword xxx in config file.
trace data loss
Output of data to the log is not possible due to insufficient memory. (Displays only when log settings are
ON).
Implementation Repository DB name not found
Implementation Repository definition filename not found.
Invalid syntax Impl DB: line number
Invalid syntax at line number in Implementation Repository definition file.
Load Error Impl DB
The Implementation Repository definition file cannot be loaded.
Implementation Repository DB full
The Implementation Repository is full.
Process pid has vanished
The ObjectDirector has found that the pid process has stopped.
Can't access directory path
The directory path cannot be accessed. Environment variable $OD_HOME is not set, or the settings are
invalid.
Over max_impl_rep_entries Queue xxx
Failed to create a queue or queue group xxx. Either increase the value of max_impl_rep_entries in the
config file, or restart the ObjectDirector.
queue_policy file is bad format
There is an error in the queuing file policy contents.
Maximum of request is invalid Queue xxx
The upper limit of the queuing file policy queue xxx is invalid.
Queuing capacity is over xxx requests
The total upper limit of the queue defined in the queuing file policy has been exceeded.
OD_QUEUE_BuildQueueSystem failed
Failed to create the queuing policy. The queue policy file is invalid, or the parameter
max_impl_rep_entries in the config file is smaller than the implementation information registered in
impl.db.
14-38
S99startod
QUEUE: RequestID id(n) was cancelled
The Request id was cancelled by the odcntlque command.
QUEUE: OD_stop timed out
The OD_stop command was executed, but a request was not completed before time-out. The
ObjectDirector detected the time-out, and terminated processing.
Note
If these messages are displayed while executing the S99startod command, either tune the system
parameter, or delete the unnecessary system source using odrmipc command.
If these messages are displayed while executing programs other than S99startod, the ObjectDirector is
not activated.
14-39
Chapter 14 : CORBA Service Operation Commands
odadmin
Name
odadmin
Initial environment set-up of ObjectDirector
Synopsis
odadmin
Description
The odadmin command sets the operation environment after the CORBA Service is introduced. The use
or existence of NamingService, InterfaceRepositoryService, and the LoadBalancingOption is
interactively confirmed, and an environment necessary for the operation is set. The database is made
immediately when use of the InterfaceRepositoryService is specified.
An outline of the set contents for this command is shown below.
•
Use or non-use of the interface repository
Contents of environment setup when the interface repository is used
•
−
The interface to use (standard interface/Value interface)
−
Database administrator/group/storage location/storage size
Use or non-use of Naming Service
Contents of environment setup when remote Naming Service is used
•
−
Host name
−
Port number
Use or not use of load balance option
Contents of environment setup when Naming Service/load balance is used
Notes
14-40
•
Execute this command when the interface repository service and the Naming Service are both in
the stopped state.
•
Before executing the odadmin command, delete (or add comment to) the host name specified in
the initial_hosts file for the interface repository and Naming Services. Wait until odadmin is
executed before setting a different host for initial_hosts.
•
If “quit(q)” is entered in response to a response character string, the environment setting process
terminates.
odadmin
•
If the standard and value interfaces are both used, specify the standard interface first, and then the
value interface, when setting the environment. If specified in this sequence and the setting process
for the value interface environment fails, the standard interface repository service stops.
•
If the interface repository and Naming Services and the load balance option are all used, each
service is started from the odadmin command. However, if “no initialization” is specified for an
interface repository database that is already registered, startup of the interface repository service
may take a long time if the database is large. In this situation, start the interface repository service
separately, rather than from the odadmin command.
•
If an interface repository database is already registered but the entered settings indicate that the
interface repository service is not used, the database is not initialized.
•
If use of a remote Naming Service is specified and the Naming Service or load balance option is
registered at the local host, the database is initialized.
•
If the settings entered for the Naming Service and load balance option indicate character set
conversion of binding names is not used, the binding name is not converted. However, if the local
host Naming Service and load balance options are used and the settings are changed to specify
use of character set conversion of binding names or a different code system, the database must be
initialized. After initialization, the required object references must be re-registered.
•
The environment setting process sequence is the interface repository service, then the Naming
Service and load balance option. Therefore, if the environment setting process fails for the Naming
Service or load balance option, the odadmin command terminates abnormally, but the environment
setting process for the interface repository service terminates normally.
Remarks
(1) Standard Interface and Value Interface
Standard Interface
This interface is required to operate a CORBA application. It is not necessary to set the standard
interface when the server is used only as an EJB runtime environment.
Value Interface
This interface is required when operating the server as an EJB runtime environment. The Value
Interface enables the use of the object passing function which is supported by Java RMI.
(2) Re-initialization of CORBA Service
When the CORBA Service needs to be re-initialized to recover resources in the event of environment
damage, the information specified at the time of setting the initial environment of the previous CORBA
Service (by the use of the odadmin command or an Interstage integrated command such as isinit), can
be reinitialized.
odadmin -f environment setup information file
The following can be used as the environment setup information file.
•
When the initial environment setup is performed with the odadmin command:
$OD_HOME/var/odenvfile
(OD_HOME: CORBA Service installation directory)
•
When the initial environment setup is performed with the Interstage integrated command:
$TD_HOME/var/iscom/isei_odenvfile
(TD_HOME: Component Transaction Service installation directory)
14-41
Chapter 14 : CORBA Service Operation Commands
When you want to modify the information that has been set in the initial environment setting or when the
environment setup information file does not exist or when the environment setting cannot be performed
correctly due to shortage of information on file, execute the odadmin command or the Interstage
integrated command.
Messages
Error: There is no file to set up.
The file necessary for the environment setting process does not exist.
Error: RepositoryID is already registered.
The RepositoryID has already been registered. A possible cause is that the Interface Repository cache
server is already activated.
Note: This message can be displayed twice.
Error: No disk space for Inter Database
There is insufficient disk space for database creation.
Error: Database install directory is ignored.
Invalid database directory.
Error: ObjectFile Create error
Failed to create a database.
Error: Database already created.
Database has already been created. Delete the database and re-execute the command.
14-42
odadmin_ex
odadmin_ex
Name
odadmin_ex
Initial environment set-up of ObjectDirector
Synopsis
odadmin_ex
Description
The odadmin_ex command sets the operation environment after the CORBA Service is introduced. The
use or existence of Naming Service, Interface Repository Service, and the Load Balancing Option is
interactively confirmed on the GUI screen, and an environment necessary for the operation is set. The
database is made at the same time when specifying that Interface Repository Service is used.
Outline of the set contents with this command are shown below.
•
Use or non-use of the interface repository
Contents of environment setup when the interface repository is used
•
−
The interface to use (standard interface/Value interface)
−
Database administrator/group/storage location/storage size
Use or non-use of Naming Service
Contents of environment setup when remote Naming Service is used
•
−
Host name
−
Port number
Use or not use of load balance option
Contents of environment setup when Naming Service/load balance is used
Notes
•
Comment or delete the host name of Interface Repository Service and Naming Service specified in
the inithost file when you carry out this command. Also, when you set up other hosts with inithost,
do the setup after you execute odadmin_ex.
•
Carry it out with the following process when you restructure Interface Repository.
Only Interface Repository Service is checked with a configuration applicable service of the GUI
screen. (Naming Service and Load Balancing Option aren't checked.)
14-43
Chapter 14 : CORBA Service Operation Commands
When EJB is used in the initialization during the initial management of Interstage, both "standard
interface" and "value interface" are chosen with an interface. When EJB isn't used, only "standard
3interface" is chosen.
A directory database storage directory present is specified in the set-up of the database.
•
When using the terminal service in Windows® 2000 Server or Windows® 2000 Advanced Server,
before executing this command execute the following command to switch to installation mode:
CHANGE USER/INSTALL
After executing this command, execute the following command to switch from installation to
application execution mode:
CHANGE USER/EXECUTE
Remarks
(1) Standard Interface and Value Interface
Standard Interface
This interface is required to operate CORBA application. It is not necessary to set the standard interface
when the server is used only as an EJB runtime environment.
Value Interface
This interface is required when operating the server as an EJB runtime environment. The Value
Interface enables the use of the object passing functionality supported by Java RMI.
(2) Re-initialization of CORBA Service
When the CORBA Service needs to be re-initialized to recover resource in the event of environment
damage, the information, which is specified at the time of setting the initial environment of the previous
CORBA Service (by the use of the odadmin_ex command or the Interstage integrated command (such
as isinit), can be re-initialized.
odadmin -f environment setup information file
The following can be used as the environment setup information file.
•
When the initial environment setup is performed with the odadmin_ex command:
Interstage install directory\ODWIN\var\odenvfile
•
When the initial environment setup is performed with the Interstage integrated command:
Interstage install directory\TD\var\iscom\isei_odenvfile
When you want to modify the information that has been set in the initial environment setting or when the
environment setup information file does not exist (or the environment setting cannot be performed
correctly due to shortage of information on file) execute the odadmin_ex command or the Interstage
integrated command.
14-44
odadmin_ex
Messages
The message and the meaning displayed when starting are shown below.
Error: There is no file to set up.
The file necessary for the conversion process does not exist.
Error: RepositoryID is already registered.
The RepositoryID has already been registered. A possible cause is that the Interface Repository cache
server is already activated.
Note: This message can be displayed twice.
Error: no disk space for Inter Database
There is insufficient disk space for database creation.
Error: database install directory is ignored.
Invalid database directory.
Error: ObjectFile Create error
Failed to create a database.
Inter: Database already created.
A file related to the database already exists in the database storage directory.
14-45
Chapter 14 : CORBA Service Operation Commands
odcntlque
Name
odcntlque
Activates/deactivates the queuing policy.
Synopsis
1.
Activating the queuing policy
odcntlque
2.
groupname [-M system]
-d
{[-que] [-dsp]}
groupname [-M system]
Cancelling queued requests
odcntlque
4.
{[-que] [-dsp]}
Deactivating the queuing policy
odcntlque
3.
-a
-c
groupname [-M system]
Stopping the server application
odcntlque
-s
[-kill]
groupname [-M system]
Description
This command activates and deactivates the queuing policy registered by the odsetque command and
the server application being executed. The odcntlque command is invalid for server applications of
server per method type.
The options and arguments of this command are as follows:
-a
Activates the queuing policy.
-d
Deactivates the queuing policy.
-c
Cancels queued requests.
-s
Stops the server application. If multiple processes are operating, it stops all processes.
-que
Activates or deactivates request receipt processing.
14-46
odcntlque
-dsp
Activates or deactivates request processing.
-kill
Forcibly stops the server application. This command is not valid in Windows NT® and Windows® 2000.
groupname
Specify the queue name or queue group name to be activated or deactivated. The implementation
repository IDs of server applications that have not been registered in queues (the odsetque command
has not been run) can also be specified.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Activating the Queuing Policy
The server applications registered in the queuing policy can be activated in units of queues or queue
groups. One or both of the -que and -dsp options must be specified to execute a request from a client,
for an activated object, as actual processing.
The following example shows the command to start the request receipt and processing:
odcntlque -a -que -dsp queue1
The following example shows how the command restarts request receipt:
odcntlque -a -que queue1
The following example shows how the command restarts suspended request processing:
odcntlque -a -dsp queue1
Deactivating the Queuing Policy
The server applications registered in the queuing policy can be deactivated. The assignment of requests
to server applications, and request receipt can be stopped. One or both of the -que and -dsp options
must be specified.
The following example shows how the command stops request receipt:
odcntlque -d -que queue1
The following example shows how the command stops assigning requests to server applications:
odcntlque -d -dsp queue1
14-47
Chapter 14 : CORBA Service Operation Commands
Canceling Queued Requests
Unprocessed requests that have been received can be deleted. To delete them, temporarily stop
request assignment.
The following example shows how the command stops assigning requests to server applications, and
deletes unprocessed requests:
odcntlque -d -que queue1
odcntlque -c queue1
Stopping the Server Application
The server application being executed can be terminated. Note that the server application will only be
terminated after all requests have been processed. When specifying the -kill option, any unprocessed
request is cancelled, and the server application is stopped. If the server application is in a loop, it cannot
be stopped.
The following example shows how the command stops the server application:
odcntlque -s queue_group1
odcntlque -s -kill queue_group1
Note
When invoking this command, do not include $OD_HOME/lib/nt in the environment variable
LD_LIBRARY_PATH.
OD_HOME: Package storage directory for CORBA Service
Messages
The following messages can be displayed at command execution:
ObjectDirector not active
The CORBA Service is not started.
groupname not found
The groupname could not be found.
groupname is not specified
The groupname is not specified.
14-48
odlistir
odlistir
Name
odlistir
Lists the registered Interface Repository information.
Synopsis
odlistir
[-l|-r RepositoryId] [-f filename] [-M system]
Description
The odlistir command displays object interface information registered in the Interface Repository.
This command shows repository objects (route objects) with vertical lines for the inclusive relationships
back to the starting point, and displays interface information fetched from the Interface Repository with
the CORBA_Contained_describe method.
If no object is specified, interface information for all objects registered in the interface repository is
shown.
Refer to information on programming for the Interface Repository service in the Distributed Application
Development Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard
Edition products for details of the types of object managed by the Interface Repository and for
inclusive/inherited relationships of Interface Repository objects.
The following parameters can be specified:
-l
Displays interface information for objects selected in conversational mode.
An object type list is displayed when this command is executed. Select from the list the object type for
which you wish to display information, to display a list of repository IDs for each object selected. When
a repository ID is selected, the interface information for all objects included within the object is displayed.
-r RepositoryId
Displays interface information for the object specified by the repository ID and all objects included within
that object.
-f filename
Outputs interface information to the file specified.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
14-49
Chapter 14 : CORBA Service Operation Commands
Example
When the following IDL definitions are registered in the Interface Repository:
module ExModule{
interface ExInterface{
long ExOperation(in long con1);
};
};
odlistir
Root_Repository
|
+ CORBA_ModuleDef
| |
name
: ExModule
| |
id
: IDL:ExModule:1.0
| |
defined_in : IR.944786264.0
| |
version
: 1.0
| |
| + CORBA_InterfaceDef
| | |
name
: ExInterface
| | |
id
: IDL:ExModule/ExInterface:1.0
| | |
defined_in : IDL:ExModule:1.0
| | |
version
: 1.0
| | |
| | |
base_interfaces
| | |
_maximum
: 0
| | |
_length
: 0
| | |
*_buffer
: 00000000
| | |
| | |
| | + CORBA_OperationDef
| | |
name
: ExOperation
| | |
id
: IDL:ExModule/ExInterface/ExOperation:1.0
| | |
defined_in : IDL:ExModule/ExInterface:1.0
| | |
version
: 1.0
| | |
result
: CORBA_tk_long
| | |
mode
: OP_NORMAL
| | |
| | |
contexts
| | |
_maximum
: 0
| | |
_length
: 0
| | |
*_buffer
: 00000000
| | |
| | |
parameters
| | |
_maximum
: 1
| | |
_length
: 1
| | |
*_buffer
: 0131349c
| | |
CORBA_ParameterDescription DATA [1]
| | |
name
: ::ExModule::ExInterface::ExOperation::con1
| | |
type
: CORBA_tk_long
| | |
type_def
: Primitive_long
| | |
mode
: PARAM_IN
| | |
| | |
exceptions
14-50
odlistir
|
|
|
|
|
| |
| |
| |
|
_maximum
_length
*_buffer
: 0
: 0
: 00000000
odlistir –l
Select the calling interface.
1.
4.
7.
10.
ModuleDef
ConstantDef
EnumDef
AttributeDef
2.
5.
8.
11.
InterfaceDef
StructDef
AliasDef
END
3. OperationDef
6. UnionDef
9. ExceptionDef
Specify the number ==> _
Select 2 (InterfaceDef) from this output screen. The RespositoryId list for
the
InterfaceDef objects registered in the interface repository is then
displayed as
below:
InterfaceDef RepositoryId list
1. IDL:ExModule/ExInterface:1.0
Specify the number ==> _
Select a RepositoryId to display interface information from this output
screen. In
this example, select 1.
|
+
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CORBA_InterfaceDef
|
name
: ExInterface
|
id
: IDL:ExModule/ExInterface:1.0
|
defined_in : IDL:ExModule:1.0
|
version
: 1.0
|
|
base_interfaces
|
_maximum
: 0
|
_length
: 0
|
*_buffer
: 00000000
|
|
+ CORBA_OperationDef
|
name
: ExOperation
|
id
: IDL:ExModule/ExInterface/ExOperation:1.0
|
defined_in : IDL:ExModule/ExInterface:1.0
|
version
: 1.0
|
result
: CORBA_tk_long
|
mode
: OP_NORMAL
|
|
contexts
|
_maximum
: 0
14-51
Chapter 14 : CORBA Service Operation Commands
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
_length
*_buffer
: 0
: 00000000
parameters
_maximum
: 1
_length
: 1
*_buffer
: 0131349c
CORBA_ParameterDescription DATA [1]
name
: ::ExModule::ExInterface::ExOperation::con1
type
: CORBA_tk_long
type_def
: Primitive_long
mode
: PARAM_IN
exceptions
_maximum
_length
*_buffer
: 0
: 0
: 00000000
odlistir -r IDL:ExModule/ExInterface/ExOperation:1.0
|
+ CORBA_OperationDef
|
name
: ExOperation
|
id
: IDL:ExModule/ExInterface/ExOperation:1.0
|
defined_in : IDL:ExModule/ExInterface:1.0
|
version
: 1.0
|
result
: CORBA_tk_long
|
mode
: OP_NORMAL
|
|
contexts
|
_maximum
: 0
|
_length
: 0
|
*_buffer
: 00000000
|
|
parameters
|
_maximum
: 1
|
_length
: 1
|
*_buffer
: 00d32e2c
|
CORBA_ParameterDescription DATA[1]
|
name
: ::ExModule::ExInterface::ExOperation::con1
|
type
: CORBA_tk_long
|
type_def
: Primitive_long
|
mode
: PARAM_IN
|
|
exceptions
|
_maximum
: 0
|
_length
: 0
|
*_buffer
: 00000000
14-52
odlistns
odlistns
Name
odlistns
Displays what has been registered with the Naming Service.
Synopsis
odlistns [-R] [-l] [name] [-M system]
Description
This command displays the content of the object reference registered with the Naming Service by
means of the OD_or_adm command. The parameters that can be specified are as follows:
-R
Display the root naming context or the specified naming context path recurrently.
-l
Display the details of the registered object reference.
name
If the desired naming context is other than the root naming context, specify in character array binding
name format. Refer to information about Character Array Binding Names in the Distributed Application
Development Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard
Edition products.
At the same time, the naming context of the Naming Service on the other hosts can be specified using
the format of URL schema. (Refer to "URL Schema" in the Distributed Application Development Guide
(CORBA Service Edition). This is provided with Enterprise Edition and Standard Edition products.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
14-53
Chapter 14 : CORBA Service Operation Commands
Detailed Information on Object Reference
When the -l option is specified, the following object reference detail information is displayed:
Name(Type)
cnauto::intf(o)
(a)
(b)
Object information(detail)
Default object information(detail)
IDL:cnauto/intf:1.0, IDL:cnauto/intf:1.0, (r2d2:8002:1.1)
(c)
(d)
(e)
(f) (g)
a)
Name registered in Naming Service
b)
Registered data type
c)
Interface repository name
d)
Implementation repository name
e)
Object host name
f)
Object port number
g)
Object version
Note
If 257 or more load balance object groups are registered, it is not possible to back up/export all object
groups.
Messages
The meanings of the messages displayed when this command is started are as follows:
SYSTEM Exception raised:IDL:CORBA/StExcep/COMMFAILURE:1.0
The CORBA Service is not yet started or the Naming Service is not yet registered in the initial service.
SYSTEM Exception raised:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The Naming Service is not yet started or the specified binding name is not yet registered as a naming
context.
SYSTEM Exception raised:IDL:CORBA/StExcep/UNKNOWN:1.0
There is an error in the specified binding name.
Exception raised:IDL:CosNaming/NamingContext/NotFound:1.0
The specified naming context is not yet registered.
14-54
odlistns
Example
odlistns
Name(Type)
NC001(c)
cnauto::intf(o)
lbg001(l)
IntfID
IDL:CosNaming/NamingContext:1.0
IDL:cnauto/intf:1.0
IDL:ISOD/LBG:1.0
odlistns /NC001
Name(Type)
ior001(o)
IntfID
IDL:cnauto/intf:1.0
odlistns –l
Name(Type)
Object information(detail)
Default object information(detail)
NC001(c)
IDL:CosNaming/NamingContext:1.0,
IDL:CosNaming/NamingContext:1.0,
(r2d2:8002:1.0:), context.918625395.0
cnauto::intf(o) IDL:cnauto/intf:1.0, IDL:cnauto/intf:1.0,
(r2d2:8002:1.0:)
lbg001(l)
IDL:ISOD/LBG:1.0, FUJITSU-Interstage-NSLBO,
(r2d2:8002:1.1:NONE)
IDL:cnauto/intf:1.0, IDL:cnauto/intf:1.0,
(r2d2:8002:1.0:)
odlistns –R
Name(Type)
NC001(c)
NC001/ior001(o)
cnauto::intf(o)
lbg001(l)
IntfID
IDL:CosNaming/NamingContext:1.0
IDL:cnauto/intf:1.0
IDL:cnauto/intf:1.0
IDL:ISOD/LBG:1.0
Note
Type signifies the following:
c: naming object
o: object
l: load balance object group
14-55
Chapter 14 : CORBA Service Operation Commands
odsethost
Name
odsethost
Adds, deletes, or displays the host information on a server on which the CORBA Service operates.
Synopsis
1.
Adding host information
odsethost -a -h host -p port [-M system]
2.
Deleting host information
odsethost –c [-M system]
odsethost -d -h host [-M system]
3.
Displaying host information
odsethost –v [-M system]
Description
The odsethost command adds, deletes, or displays the host information on a server on which the
CORBA Service operates. The specified data is set in the initial_hosts (inithost) file.
The options and arguments of this command are as follows:
-a
This command adds the host information on a server machine on which the CORBA Service operates.
Up to 16 host information records can be registered.
-h host
Specifies the name of a host to be added or deleted.
-p port
Specifies the port number to be added.
-c
Deletes all the host information that is already set.
-d
Deletes the host information that is already set.
-v
Displays the host information that is already set.
14-56
odsethost
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The setting sequence of the host information can be changed by using the -d and -a options or by
directly editing the initial_hosts (inithost) file.
•
An already registered host name cannot be added. The system does not check whether the host
name matches the IP address.
•
The added or changed host information is validated when the CORBA Service is started next.
Messages
The following messages can be displayed at command execution:
You are not super-user and cannot modify.
The host information cannot be added or deleted because you do not have the administrator authority.
Execute this command again by using the administrator authority.
Failed to modify initial host file. (Error = error code)
Another application may be using the initial_hosts (or inithost) file. Stop the application that is accessing
the initial_hosts (or inithost) file, and then execute this command again.
Invalid inithost file. (line = xxx)
Invalid initial_hosts file. (line = xxx)
There are incorrect descriptions in the line number, "line" of the inithost file. Directly edit the inithost file.
host not exist: host name
The specified host name is not set in the host information. Check the set host information by using the v option.
host already registered: host name
The specified host is already set in the host information. Delete the host, and then add it again.
Cannot open file: file name
A file open error occurred. Check that specified file exists.
16 sets of host names are already registered.
There are 16 host names already set in the host information: this is the maximum allowable number.
Delete unnecessary host names, and then add the necessary new ones.
14-57
Chapter 14 : CORBA Service Operation Commands
odsetque
Name
odsetque
Registers, deletes and displays the server application in/from the queuing policy.
Synopsis
1.
Registering a server application in the queuing policy:
odsetque -a {-q|-w} groupname membername1 [membername2 ...] [-M system]
2.
Deleting a server application from the queuing policy:
odsetque -d {-q|-w} groupname [-M system]
3.
Displaying the server applications registered in the queuing policy:
odsetque
-l [-M system]
Description
This command registers, deletes or displays the implementation information of server applications for
the queuing policy. Registered server applications process requests from clients according to the
queuing policy.
Only the user who belongs to Administrators local group can execute this command. When using the
queuing policy for the first time, copy the queue_policy.default from the queuing policy prototype file to
create a queue_policy file. Save this file in the following directory:
(Default installation path)
C:\Interstage\ODWIN\etc
(Default installation path)
/opt/FSUNod/etc
/opt/FJSVod/etc
14-58
odsetque
The options and arguments of this command are as follows:
-a
This parameter specifies that the command registers the server application corresponding to the
specified Implementation Repository ID in the queuing policy.
-d
This parameter specifies that the command deletes the server application corresponding to the specified
Implementation Repository ID from the queuing policy.
-l
This parameter specifies that the command displays a list of server applications registered in the
queuing policy.
-q
This parameter specifies that queue operation is to be performed.
-w
This parameter specifies that a queue group operation is to be performed.
groupname
This parameter specifies a queue name or queue group name for registering or deleting server
applications in/from the queuing policy. A character string of up to 255 characters can be specified.
membername
This parameter specifies an Implementation Repository ID or queue name to be registered in a queue
group.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Registering Server Applications in the Queuing Policy
To register multiple server applications in the queuing policy, specify multiple Implementation Repository
IDs as a queue. Existing queues can be managed as a queue group by using an alias.
Before registering a server application in the queuing policy, register the Implementation Repository ID
for the server application using the OD_impl_inst command. The following example shows how to
register Implementation Repository IDs in a queue group:
odsetque -a -q queue1 IDL:test1/intf1:1.0 IDL:test2/intf2:1.0
The following example shows how to manage multiple queues registered in the queuing policy as a
queue group:
odsetque -a -w queue_group1 queue1 queue2 ...
14-59
Chapter 14 : CORBA Service Operation Commands
Each server application registered in the queuing policy can be activated or deactivated by invoking the
odcntlque command.
The information registered in the queuing policy becomes valid when the CORBA Service starts up.
Deleting Server Applications from the Queuing Policy
The following examples show how to delete server applications from the queuing policy. Specify a
queue name or queue group name.
Register the Implementation Repository ID of the Naming Service or Interface Repository in the queuing
policy.
Examples
odsetque -d -q queue1
odsetque -d -w queue_group1
Display list of the Queuing Policy
Displays a list of the server applications registered in the queuing policy.
odsetque –l
Displays “No QueueGroup entry” or “No Queue entry” if the entry is not registered.
The Maximum Limit of Receivable Requests
The maximum limit of the receivable requests for the entire system is defined in the config file.
Maximum limit = max_IIOP_resp_requests
(If less than 256, it is set to 256.)
If a different limit of receivable requests is to be set for each queue, define the limits in the [GUARANTY]
section of the queuing policy file.
The following example sets the limit of a queue named queue1 to 64.
[GUARANTY]
queue1 = 64
If the maximum limit of a queue is not defined, the maximum system limit will then be used.
Queuing Policy
This is the CORBA Service definition file for queue control actions.
The queuing policy defines dispatching requests to queues.
14-60
odsetque
Notes
•
The old command name queset remains for the purpose of compatibility with earlier versions, but
use of odsetque is recommended.
•
The following environment variable must be set (unless already set) when odsetque is executed:
OD_HOME:
•
CORBA service install directory
The CORBA Service must be restarted for the information registered in a queuing policy to take
effect.
Messages
The following messages can be displayed at command execution:
groupname already exists
The groupname already exists.
groupname not found
The groupname could not be found.
groupname is invalid
The groupname is invalid.
groupname is too long
The groupname is too long.
membername already registered
The membername is already registered.
ImplementationRepositoryID not found
The Implementation Repository ID could not be found.
OD_HOME is not set
The environment variable “OD_HOME” is not set.
cannot open queue_policy file
The queue_policy file cannot be opened.
cannot create queue_policy file
The queue_policy file cannot be created.
writing queue_policy file failed
Failed to write to the queue_policy file.
renaming queue_policy file failed
Failed to rename the queue_policy file.
cannot open impl.db file
The impl.db file could not be opened.
14-61
Chapter 14 : CORBA Service Operation Commands
14-62
Chapter 15
WorkUnit Management Commands
This chapter details the WorkUnit Management commands.
The WorkUnit management commands are available for the following products.
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
Note
If Plus is used, only the following commands can be used .
−
isaddwudef
−
isdelwudef
−
islistwu
−
isstartwu
−
isstopwu
−
islistwudef
−
isinfwudef
−
isresetretrycount
−
isinfobj
−
islistobj
−
islistaplproc
Up to 97 WorkUnit, management commands can be executed at the same time.
When 98 or more WorkUnit management commands are executed at the same time, the system
displays the message EXTP0695, and fails to execute the commands.
15-1
Chapter 15: WorkUnit Management Commands
isaddwudef
Name
isaddwudef
Adds a WorkUnit definition.
Synopsis
isaddwudef [-M system-name] [-o] work-unit-definition-file-name
Description
This command registers a WorkUnit definition.
The option and argument for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-o
Overwrites a WorkUnit definition with the same name when registered. Registers a new WorkUnit
definition if no WorkUnit definition has been registered.
If this option is omitted, the WorkUnit definition is only registered if no other WorkUnit definition with the
same name is registered.
work-unit-definition-file-name
Specify the file name of a text file containing the WorkUnit definition. If the file name contains blanks,
enclose the file name in single or double quotation marks.
Note
Incomplete definitions will not be registered.
Examples
Register through file ‘create-def.wu’ that contains the WorkUnit definitions:
isaddwudef create-def.wu
Register by overwriting file ‘create-def.wu’ that contains the WorkUnit definitions:
isaddwudef -o create-def.wu
15-2
isdelwudef
isdelwudef
Name
isdelwudef
Deletes a WorkUnit definition.
Synopsis
isdelwudef [-M system-name] work-unit-name
Description
This command deletes a WorkUnit definition.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
work-unit-name
Specify each WorkUnit name. Multiple WorkUnit names separated by spaces can be specified.
Wild cards can also be used by specifying asterisks in the WorkUnit name. If using a wild card, enclose
the WorkUnit name in single or double quotation marks.
Examples
Delete WorkUnit definitions for WorkUnits beginning with ‘TDSAMPLE’:
isdelwudef “TDSAMPLE*”
Delete WorkUnit definitions for WorkUnits ‘TDSAMPLE1’ and ‘TDSAMPLE2’:
isdelwudef TDSAMPLE1 TDSAMPLE2
15-3
Chapter 15: WorkUnit Management Commands
islistwu
Name
islistwu
Displays a list of WorkUnits.
Synopsis
islistwu [-a] [-M system-name]
Description
This command displays the operating status of all operating WorkUnits. The following information is
displayed:
•
WorkUnit name
•
WorkUnit type. The following types are listed:
For Plus, only the EJB WorkUnit is displayed.
15-4
−
−
−
−
CORBA: CORBA WorkUnit
TD: Transaction application WorkUnit
WRAPPER: Wrapper WorkUnit
EJB: EJB WorkUnit
−
−
−
−
−
CORBA: CORBA WorkUnit
TD: Transaction application WorkUnit
WRAPPER: Wrapper WorkUnit
EJB: EJB WorkUnit
UTY: WorkUnit with a load module specified
−
−
−
−
CORBA: CORBA WorkUnit
TD: Transaction application WorkUnit
EJB: EJB WorkUnit
UTY: WorkUnit with a load module specified
islistwu
•
Operating status. The following operating statuses are listed:
−
startproc: Starting
−
execute: Started
−
stopproc: Stopping
−
stop: Stopped
The following options can be specified:
-a
Also displays WorkUnits whose definitions have been registered but that have not been started.
-M system-name
Specify the target system name.
Note
The login user name of the user who executes this command must be 8 bytes or less.
Example
islistwu -a
wuname
CORBAWU
TDWU
EJBWU
WRAPPERWU
kind
CORBA
TD
EJB
WRAPPER
status
startproc
startproc
execute
stop
15-5
Chapter 15: WorkUnit Management Commands
isstartwu
Name
isstartwu
Starts WorkUnits.
Synopsis
isstartwu [-M system-name] wuname
Description
This command starts WorkUnits.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the name of the WorkUnit to be started.
When starting an EJB container, specify the EJB container name.
15-6
isstartwu
Notes
•
The isstartwu command will not respond if there is insufficient memory.
•
The isstartwu command can only be used to start WorkUnits by users with authority to start the
Component Transaction Service. For that reason, users with authority to start the Component
Transaction Service must have the following authorities for resources accessed by applications in
WorkUnits:
−
−
−
•
The WorkUnit started with the isstartwu command operates under the authority of the user who
entered the command. Therefore, that user must have the following authority over the resources
accessed by applications in the WorkUnit:
−
−
−
•
Permission to read and write disk partitions in application systems
Access authority to use folders and files that specify WorkUnit definitions
Authority to use resources used by applications in WorkUnits.
Permission to read and write disk partitions in application systems
Authority over the UNIX file system required to use the directory and file specified in the
WorkUnit definition.
Authority to use resources used by applications in WorkUnits.
The login user name of the user who executes this command must be 8 bytes or less.
Example
isstartwu ISWU
15-7
Chapter 15: WorkUnit Management Commands
isstopwu
Name
isstopwu
Stops WorkUnits.
Synopsis
isstopwu [-M system-name] [-s|-c] wuname
Description
This command stops WorkUnits. There are two ways of stopping WorkUnits:
•
Normal stop
•
Synchronous stop
•
Forced stop
With normal stop, the WorkUnit stops when no applications defined in the WorkUnit are performing
processing. The WorkUnit cannot be stopped while a WorkUnit is processing a task. In such cases,
wait until the application has finished processing, and then re-enter the command. It is effective for a
WorkUnit of a transaction application, a Wrapper WorkUnit, a CORBA WorkUnit and an EJB WorkUnit.
For Plus, only the EJB WorkUnit is available.
A synchronous stop stops a WorkUnit, after performing any demand which is under processing at the
time of command execution. A demand which is in a waiting state is rejected. It is effective for a CORBA
WorkUnit and an EJB WorkUnit. For Plus, only the EJB WorkUnit is available.
With forced stop, the WorkUnit is stopped even if an application is currently performing processing.
A demand which is in a waiting state is rejected. A compulsive stop can also be performed during
processing of a synchronous stop. It is effective for the WorkUnit of transaction application, a wrapper
WorkUnit, a utility WorkUnit, a CORBA WorkUnit, and an EJB WorkUnit. For Plus, only the EJB
WorkUnit is available.
The option and argument of this command are as follows. When the stop mode option is not specified, it
is stopped normally.
15-8
isstopwu
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-s
Specifies synchronous stop.
-c
Specifies forced stop.
wuname
Specify the name of the WorkUnit to be stopped.
When stopping an EJB container, specify the EJB container name.
Notes
•
If a WorkUnit is stopped while a transaction application snapshot is being collected, collection of
the snapshot is halted automatically. There is no need to use the tdstopsnap command to halt
collection of the snapshot.
•
When the server application is stopped forcibly while processing is under way, the pop-up dialog of
application error may be output. If this dialog is output, terminate the pop-up dialog. When the popup dialog is terminated, the stopping process is continued.
•
A WorkUnit can only be stopped by the user who started it.
•
While debugging an application, the WorkUnit started by the tdstartwu command using the -d
option, cannot be stopped with the -c option.
Example
isstopwu TDSAMPLE1
15-9
Chapter 15: WorkUnit Management Commands
islistwudef
Name
islistwudef
Displays a list of WorkUnit names of defined WorkUnits.
Synopsis
islistwudef [-M system-name]
Description
This command outputs to standard output a list of names of WorkUnits whose definitions have already
been defined.
The option and argument of this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Example
islistwudef
TDSAMPLE1
TDSAMPLE2
15-10
isinfwudef
isinfwudef
Name
isinfwudef
Displays the contents of WorkUnit definitions for registered WorkUnits.
Synopsis
isinfwudef [-M system-name] wuname
Description
This command outputs to standard output the contents of WorkUnit definitions in the format in which
they were registered for WorkUnits that have been registered.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the name of the WorkUnit to be displayed.
Example
isinfwudef TDSAMPLE1
[WORK UNIT]
Name:TDSAMPLE1
Kind:ORB
[APM]
Name:TDNORM
[Control Option]
Path:C:\INTERSTAGE\td\sample\C_SERVER
Current Directory:C:\tmp
[Application Program]
Destination:TDSAMPLE1/INTF
Executable File:libtdsample1.dll
Application Language:C
15-11
Chapter 15: WorkUnit Management Commands
isresetretrycount
Name
isresetretrycount
Resets the retry count of abnormal termination that is already counted.
Synopsis
isresetretrycount [-M systemname] wuname Executablefile
Description
This command resets the retry count of abnormal termination that is already counted.
The argument of this command is as follows:
-M system-name
Specify the target system name.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the name of the WorkUnit whose retry count should be reset.
Executablefile
Specify the executable file name that resets the retry count.
Example
isresetretrycount –M system1 sample_wu sample
15-12
isinfobj
isinfobj
Name
isinfobj
Displays details of an object.
Synopsis
isinfobj [-M system-name] [-a] [wuname] objname
Description
This command displays detailed information for operating objects, the EJB application, or the
implementation repository of CORBA application. For Plus, only an EJB application is displayed.
The information displayed varies depending on the type of object, application or implementation
repository.
The following information is output:
Transaction applications or wrapper applications
•
Object name
•
Object type
The following object types are displayed:
−
TD: Transaction application object
−
WRAPPER: Wrapper application object
•
Object status
The following object statuses are displayed:
−
active: Operating
−
inhibit: Closed
•
Application process multiplicity for object
•
Number of client requests queued for object
•
Cumulative number of queues for object (*1)
•
WorkUnit name defining object.
Transaction applications
•
Object name
•
Object type
The following object types are displayed:
15-13
Chapter 15: WorkUnit Management Commands
−
TD: Transaction application object
•
Object status
The following object statuses are displayed:
−
active: Operating
−
inhibit: Closed
•
Application process multiplicity for object
•
Number of client requests queued for object
•
Cumulative number of queues for object (*1)
•
WorkUnit name defining object
(*1) This becomes the number of accumulation of demands from the client to an object.
EJB applications
•
Application name
•
Application type
The following application type is displayed:
−
EJB: EJB application
•
Application form
The following application forms are displayed:
−
stateless: STATELESS session
−
stateful: STATEFUL session
−
BMP-Entity: Bean-managed persistence Entity Bean
−
CMP-Entity: Container-managed persistence Entity Bean
−
Message Driven Ben: Message-Driven Bean
−
EJB Container: Light EJB Container
•
Application status
The following is displayed when application is applying.
−
active: Operating
−
inhibit: Closed
•
Application process multiplicity
•
Number of client requests queued for object
0 is displayed for the Message Driven Bean.
15-14
•
Cumulative number of queues for application (*1)
*1) This becomes the number of accumulation of demands from the client to application.
•
Number of instances for application
The following information is displayed for every form of application.
−
stateless : The number of initial starting instances set up by the execution environmental
definition of the EJB application of a customize tool is displayed.
−
stateful : 0 is displayed.
−
BMP-Entity : The number of instances set up by the high-speed call definition of a customize
tool is displayed.
−
CMP-Entity : The number of instances set up by the high-speed call definition of a customize
tool is displayed.
isinfobj
−
−
•
Message Driven Bean : The number of instances set up by the customization tool is displayed.
1 is set except when NotSupported is specified as a transaction attribute.
EJB Container :Indicates 0.
WorkUnit name defining object
Implementation repository corresponding to CORBA applications
•
Implementation repository ID
•
Application type
The following application type is displayed:
−
CORBA: Implementation repository corresponding to CORBA applications
•
Implementation repository status
There are the following states as a state of an object.
−
active : The state under employment
−
inhibit : The state under blockade
•
The object name set up in implementation repository
•
The degree of process multiplex of the application corresponding to implementation repository
•
The number of demands from the client which is piling up in implementation repository
•
The accumulation processing number of cases in implementation repository
•
The number of threads which is operating by implementation repository
•
The WorkUnit name by which implementation repository is defined
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-a
When implementation repository ID is specified to be objname, the interface list in implementation
repository ID and a state are displayed.
wuname
The name of the WorkUnit in which objname which displays detailed information is contained is
specified. When displaying the information on implementation repository of a CORBA WorkUnit,
specification of this parameter is indispensable.
objname
Specify the name of the object or application for which detailed information is to be displayed.
Notes
•
If an EJB application has terminated abnormally, the number of queues at the application is deleted.
•
Do not execute this command when the isstopwu or tdstopwu command is running.
15-15
Chapter 15: WorkUnit Management Commands
•
The login user name of the user who executes this command must be 8 bytes or less.
Examples
Transaction application or wrapper application
isinfobj TDSAMPLE1/INTF
objectname
:TDSAMPLE1/INTF
kind
:TD
status
:active
procnum
:1
queue
:10
accumulation
:10
wuname
:TDSAMPLE1
Transaction application
isinfobj TDSAMPLE1/INTF
objectname
:TDSAMPLE1/INTF
kind
:TD
status
:active
procnum
:1
queue
:10
accumulation
:10
wuname
:TDSAMPLE1
15-16
isinfobj
EJB application
isinfobj EJBAPL
applicationname
kind
type
status
procnum
queue
accumulation
instance
wuname
:EJBAPL
:EJB
:stateless
:active
:10
:10
:85
:2
:EJBWU
Implementation repository corresponding to CORBA applications
isinfobj corbawu IDL:FJ/ImplementationRep:1.0
implID
: IDL:FJ/ImplementationRep:1.0
kind
: CORBA
status
: active
procnum
: 1
queue
: 10
accumulation
: 10
thread
: 3
wuname
: TDSAMPLE1
isinfobj -a corbawu IDL:FJ/ImplementationRep:1.0
implID
: IDL:FJ/ImplementationRep:1.0
kind
: CORBA
status
: active
procnum
: 1
queue
: 10
accumulation
: 10
thread
: 3
wuname
: TDSAMPLE1
----------object
: IDL:test1/intf1
status
: active
----------object
: IDL:test2/intf2
status
: inhibit
15-17
Chapter 15: WorkUnit Management Commands
islistobj
Name
islistobj
Displays a list of objects.
Synopsis
islistobj [-M system-name]
Description
This command displays the operating status of all the active objects, the EJB application or
implementation repository. The following details are displayed. (For Plus, only an EJB application is
displayed.)
•
Object name, EJB application name, or implementation repository ID corresponding to the CORBA
application which is operating by the WorkUnit subordinate.
•
Type
Shown below are the types of objects, an EJB application, or implantation repository ID:
−
CORBA : Implementation repository ID corresponding to CORBA application
−
EJB: EJB application
−
TD: Transaction application object
−
WRAPPER: Wrapper application object
•
Operation status
The following operation statuses are displayed:
−
active: Operating
−
inhibit: Closed
•
WorkUnit name for which an object, EJB application or implementation repository ID is defined.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
15-18
islistobj
Note
•
The login user name of the user who executes this command must be 8 bytes or less.
Example
islistobj
objectname/applicationname
IDL:FJ/ImplementationRep:1.0
TDAPL/INTF
WRAPAPL/INTF
EJBAPL
kind
CORBA
TD
WRAPPER
EJB
status
active
inhibit
active
active
wuname
CORBAWU
TDWU
WRAPPERWU
EJBWU
islistobj
objectname/applicationname
IDL:FJ/ImplementationRep:1.0
TDAPL/INTF
EJBAPL
kind
CORBA
TD
EJB
status
active
inhibit
active
wuname
CORBAWU
TDWU
EJBWU
15-19
Chapter 15: WorkUnit Management Commands
islistaplproc
Name
islistaplproc
Displays process information about an application operated with a WorkUnit.
Synopsis
islistaplproc [-M system-name] [wuname]
Description
The islistaplproc command displays all process information for all the operating WorkUnits. The
following contents appear as display information. For Plus, only EJB is displayed.
•
Process ID
•
WorkUnit name
•
•
WorkUnit type. The WorkUnit types are shown below:
−
−
−
CORBA : CORBA WorkUnit
EJB : EJB WorkUnit
TD : Transaction application WorkUnit
−
UTY : Utility WorkUnit
Application name. The following information is displayed for each WorkUnit type:
−
−
−
CORBA : Implementation repository ID
EJB : EJB application name
TD : Object name.
−
UTY : Application execution file name
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the name of a WorkUnit for which process information is to be displayed. When this option is
specified, the system only displays the information about a process that is operating for the specified
WorkUnit subordinate.
15-20
islistaplproc
Notes
•
The login user name of the user who executes this command must be 8 bytes or less.
Example
islistaplproc
PID
wuname
1001
TDSAMPLE1
1002
TDSAMPLE2
1003
TDSAMPLE2
2001
EJBWU1
3001
SAMPLEWU
4001
UTYWU1
kind
TD
TD
TD
EJB
CORBA
UTY
objectname/applicationname
TDSAMPLE1/INTF
TDSAMPLE2/INTF
TDSAMPLE2/INTF
EJBAPL
IDL:test1/intf1:1.0
utyapl1.exe
15-21
Chapter 15: WorkUnit Management Commands
isinhibitque
Name
isinhibitque
The blockade of cue.
Synopsis
isinhibitque [-M system-name] wuname quename1 [quename2]
Description
The isinhibitque command blockades the cue of the demand to the application under employment.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
The WorkUnit name in which the cue which blockades is contained is specified.
quename1
The name of the cue which blockades is specified. As a cue name, the following is specified by
classification of application.
•
CORBA : Implementation repository ID corresponding to CORBA application
•
EJB : EJB application name
•
TD : object name
quename2
The name of the cue which blockades is specified. The following is specified by application classification
specified by quename1. This option is omissible.
•
15-22
CORBA : The interface in implementation repository ID specified by quename1
isinhibitque
Notes
•
This command is effective for CORBA applications, EJB applications, and transaction applications.
•
The process bind function of a transaction application is used, and it does not become effective for
the processing in progress.
•
Only the user who started the WorkUnit can blockade an object.
Example
isinhibitque TDSAMPLE1 TDSAMPLE1/INTF
15-23
Chapter 15: WorkUnit Management Commands
ispermitque
Name
ispermitque
Blockade release of cue.
Synopsis
ispermitque [-M system-name] wuname quename1 [quename2]
Description
The ispermitque command carries out blockade release of the cue of the demand to the application
under employment.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
The WorkUnit name in which the cue which performs blockade release is contained is specified.
quename1
The name of the cue which performs blockade release is specified. As a cue name, the following is
specified by classification of application.
•
CORBA : Implementation repository ID corresponding to CORBA application
•
EJB : EJB application name
•
TD : object name.
quename2
The name of the cue which performs blockade release is specified. The following is specified by
application classification specified by quename1. This option is omissible.
•
15-24
CORBA : The interface in implementation repository ID specified by quename1
ispermitque
Notes
•
This command is effective to CORBA application, EJB application, and transaction application.
•
Only the user who started the WorkUnit can blockade an object.
Example
ispermitque TDSAMPLE1 TDSAMPLE1/INTF
15-25
Chapter 15: WorkUnit Management Commands
tdformsnap
Name
tdformsnap
Edits and outputs TD snapshots.
Synopsis
tdformsnap
[-M system-name] wuname
Description
This command outputs TD snapshots.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of the WorkUnit defining the application for which a snapshot is to be output.
Notes
•
Snapshots are output in units of WorkUnits. Therefore, the snapshots of other applications defined
in the same WorkUnit are also output.
•
To issue this command, the following conditions must be satisfied:
−
−
•
The transaction system must be started.
The applicable WorkUnit must not acquire a snapshot.
The tdformsnap command is effective only for the Component Transaction Service.
Example
tdformsnap TDSAMPLE1
15-26
tdfreesnap
tdfreesnap
Name
tdfreesnap
Deletes TD snapshots.
Synopsis
tdfreesnap [-M system-name] wuname
Description
This command deletes the Component Transaction Service snapshot acquired in shared memory using
the tdstartsnap command.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of the WorkUnit defining the application for which a snapshot is to be deleted.
Notes
•
Snapshots are deleted in units of WorkUnits. Therefore, the snapshots of other applications defined
in the same WorkUnit are also deleted.
•
To issue this command, the following conditions must be satisfied:
−
−
−
•
The transaction system must be started.
The applicable WorkUnit must not acquire a snapshot.
The snapshot of the applicable WorkUnit must be acquired in shared memory.
The tdfreesnap command is effective only for the Component Transaction Service.
Example
tdfreesnap TDSAMPLE1
15-27
Chapter 15: WorkUnit Management Commands
tdlistwu
Name
tdlistwu
Displays a list of transaction application WorkUnits and WRAPPER WorkUnits.
Synopsis
tdlistwu
Description
This command displays the operational status of transaction application WorkUnits and WRAPPER
WorkUnits being used.
The following information is displayed:
•
WorkUnit name
•
Operational status. The following statuses can be entered:
−
−
−
startproc:
execute:
stopproc:
Starting
Already started
Stopping
Notes
•
This command is available in the default system only.
•
The login user name of the user who executes this command must be 8 bytes or less.
Example
tdlistwu
wuname
TDSAMPLE1
TDSAMPLE2
TDSAMPLE3
15-28
status
startproc
execute
stopproc
tdlistwusnap
tdlistwusnap
Name
tdlistwusnap
Lists the names of WorkUnits that acquired TD snapshots.
Synopsis
tdlistwusnap [-M system-name]
Description
This command lists the names and operational status of WorkUnits that acquired Component
Transaction Service snapshots using the tdstartsnap command.
The following operational statuses are available:
−
getting: Snapshot acquisition start status
−
non getting: Snapshot acquisition end status
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Note
The tdlistwusnap command is effective only for the Component Transaction Service.
Example
tdlistwusnap
block number
1
2
wuname
TDSAMPLE1
TDSAMPLE2
status
non getting
getting
15-29
Chapter 15: WorkUnit Management Commands
tdmodifywu
Name
tdmodifywu
Performs WorkUnit activation change.
Synopsis
tdmodifywu
[-M system-name] wuname
Description
This command modifies the Component Transaction Service WorkUnit definition and registers it in the
TransactionDirector environment. Definition change does not stop the TD system, but allows
modification of the WorkUnit definition, and starts and operates the WorkUnit according to the modified
definition of the WorkUnit.
Activation change can be used in the following cases:
•
When modifying the server application
•
When changing server application environment variables
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the WorkUnit name where the activation change is to be performed.
15-30
tdmodifywu
Notes
•
A conflict can occur in the application if operating parameters are changed, in which case, do not
perform the activation change.
•
Backup the WorkUnit definition file before the activation change.
•
If the activation change fails due to an incorrect definition, the WorkUnit returns to its original status.
•
If a system uses the HA function (high reliability function) and this command is used to make a
change at the operating node, the change is not reflected at the standby node. This command
cannot be used at the standby node.
•
This command cannot be used to the WorkUnit which uses a process bind function.
•
This command can be started only in a WorkUnit whose WorkUnit type is "ORB".
Only the user who started the WorkUnit can use the tdmodifywu command.
15-31
Chapter 15: WorkUnit Management Commands
tdmodifyprocnum
Name
tdmodifyprocnum
The multilevel of transaction application process of the server application is changed.
Modifies multilevel of process concurrency of server application.
Synopsis
tdmodifyprocnum
[-M system-name] wuname
objname
procnum
Description
This command modifies the multilevel concurrency of the server application for transaction applications.
The arguments of this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of the WorkUnit to which the server application to be modified belongs.
objname
Specifies the name of the object corresponding to the server application to be modified.
procnum
Specifies the number of processes for the server application after modification. A number between 1 and
255 can be set (a number outside this range will be checked out on the command side).
15-32
tdmodifyprocnum
Notes
•
The registered WorkUnit definition cannot be modified using this function.
•
This command cannot be used on objects on which the process bind function is to be used.
•
This command cannot be used while the activation modification command (tdmodifywu) is being
executed.
•
If the HA function has been used, modifications made using this command will not be reflected in
the standby system.
•
This command cannot be used at the standby node.
•
If you have exceeded the number of characters that can be executed from the command line,
execute the command using a shell script or some other means.
•
If this command has been used to repeatedly increase or decrease process multilevel concurrency,
the directories created by the process ID names will be left behind under the WorkUnit name folder
created under the current folder specified in the WorkUnit definition.
This can clog up the hard disk or other media. Therefore, to delete the leftover directories, check
the process IDs of APM processes currently in operation, using the ps command, for example, and
then delete the directories other than those of the currently operational process IDs.
•
This command can be started only in a WorkUnit whose WorkUnit type is "ORB".
•
When the number of characters which can be performed from a command line is exceeded, please
use a shell script etc. and execute a command.
15-33
Chapter 15: WorkUnit Management Commands
tdstartsnap
Name
tdstartsnap
Starts acquiring TD snapshots.
Synopsis
tdstartsnap [-M system-name] wuname
Description
This command starts acquiring TD snapshots in shared memory, and outputs them using the tdformsnap
command.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of the WorkUnit that defines the application for which a snapshot is to be acquired.
Notes
Snapshots are acquired in units of WorkUnits. Therefore, acquisition of snapshots of other applications
defined in the same WorkUnit is also started.
To issue this command, the following condition must be satisfied:
The specified WorkUnit must be started.
If the WorkUnit stops while acquiring snapshots, acquisition terminates automatically. Therefore, there is
no need to stop acquisition with the tdstopsnap command.
This command is effective only for the Component Transaction Service.
Example
tdstartsnap TDSAMPLE1
15-34
tdstartwu
tdstartwu
Name
tdstartwu
Starts a Component Transaction Service WorkUnit.
Synopsis
tdstartwu [-M system-name] [-d] wuname
Description
This command starts a Component Transaction Service WorkUnit in the following ways:
•
Normal startup
•
Test startup
Normal startup operation starts a WorkUnit for normal operation.
Test startup operation starts the applications in the WorkUnit for testing. Refer to the Distributed
Application Development Guide (Component Transaction Service Edition) for details of how to test
applications in the WorkUnit.
The arguments for this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-d
Starts testing the WorkUnit. If this option is omitted, normal startup is assumed.
wuname
Specifies the name of the WorkUnit to be started.
15-35
Chapter 15: WorkUnit Management Commands
Notes
The tdstartwu command can start only ORB and WRAPPER type WorkUnits. Use the isstartwu
command to start other types of WorkUnit.
The tdstartwu command will not respond if there is insufficient memory.
The tdstartwu command can only be used to start WorkUnits by users with authority to start the
Component Transaction Service. Therefore, that user must have the following authority over the
resources accessed by applications in the WorkUnit:
•
Read/write permission to the disk partitions for the transaction system
•
The right to access required in order to use the folder and file which were specified by the WorkUnit
definition.
•
Authority to use the resources needed by applications in the WorkUnit.
The WorkUnit started with the tdstartwu command operates under the authority of the user who entered
the command. Therefore, that user must have the following authority over the resources accessed by
applications in the WorkUnit:
•
Read/write permission to the disk partitions for the transaction system
•
The right to access required in order to use the folder and file which were specified by the WorkUnit
definition.
•
Authority to use the resources needed by applications in the WorkUnit
•
The login user name of the user who executes this command must be 8 bytes or less.
Example
tdstartwu TDSAMPLE1
15-36
tdstopsnap
tdstopsnap
Name
tdstopsnap
Terminates TD snapshot acquisition.
Synopsis
tdstopsnap [-M system-name] wuname
Description
This command terminates the acquisition of TD snapshots. After terminating the acquisition of
information with this command, use the tdformsnap command to output the snapshots.
The argument of this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of the WorkUnit that defines the application for which snapshot acquisition is to be
terminated.
Notes
Snapshots are acquired in units of WorkUnits. Therefore, acquisition of snapshots of other applications
defined in the same WorkUnit is also terminated.
To issue this command, the following condition must be satisfied:
The specified WorkUnit must be started.
If the WorkUnit stops while acquiring snapshots, acquisition terminates automatically. Therefore, there is
no need to stop acquisition with the tdstopsnap command.
This command is effective only for the Component Transaction Service.
Example
tdstopsnap TDSAMPLE1
15-37
Chapter 15: WorkUnit Management Commands
tdstopwu
Name
tdstopwu
Stops a Component Transaction Service WorkUnit.
Synopsis
tdstopwu [-M system-name] [-c] wuname
Description
This command stops a Component Transaction Service WorkUnit in the following ways:
•
Normal stop
•
Forced stop.
Normal stop stops the WorkUnit only when there are no applications defined in the WorkUnit being
processed. The WorkUnit cannot stop while processing transactions, therefore, re-execute this
command when application processing has completed.
Forced stop stops the WorkUnit even during application processing.
The option and argument of this command are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-c
Specifies forced stopping. If this option is omitted, normal stop is assumed.
wuname
Specifies the name of the WorkUnit to be stopped.
15-38
tdstopwu
Notes
•
The tdstopwu command stops only ORB and WRAPPER type WorkUnits. Use the isstopwu
command to stop other types of WorkUnit.
•
While debugging an application, the WorkUnit started by the tdstartwu command with -d option,
cannot be stopped with -c option.
•
If the WorkUnit stops while acquiring snapshots, acquisition terminates automatically. Therefore,
there is no need to stop acquisition with the tdstopsnap command.
•
When the server application is stopped forcibly while processing is under way, the pop-up dialog of
application error may be output. If this dialog is output, terminate the pop-up dialog. When the popup dialog is terminated, the stopping process is continued.
•
A WorkUnit can be stopped with this command only by the user who started it with the tdstartwu
command.
Example
tdstopwu TDSAMPLE1
15-39
Chapter 15: WorkUnit Management Commands
15-40
Chapter 16
Event Service Operation Commands
This chapter explains Event Service commands.
Note
The Event Service operation command can be used in the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
The Notification Service operation command can be used in the following products:
•
Interstage Application Server Enterprise Edition
The Event Service operation command is also used while Interstage JMS is operated. Interstage JMS
can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
16-1
Chapter 16: Event Service Operation Commands
Command Summary
Table 16-1 below summarizes the Event Service commands, and explains their arguments.
Event Service Commands
Table 16-1 Event Service Commands
Component
Command name
Outline
Environment
essetup
Sets up an Event Service
esunsetup
Deletes an Event Service
essetcnf
Administers Event Service configuration information
essecmode
Enhancement of Event Service security
esstart
Starts an Event Service
esstop
Stops an Event Service
esmonitor
Displays Event Service status
esstartfctry
Starts an Event Channel factory
esstopfctry
Stops an Event Channel factory
esmkchnl
Generates an Event Channel
esrmchnl
Deletes an Event Channel
esstartchnl
Starts an Event Channel
esstopchnl
Stops an Event Channel
essetcnfchnl
Sets an operating environment for Event Channels
esmonitorchnl
Displays event channel connection information
esmkunit
Generates a unit
esrmunit
Deletes a unit
esstartunit
Starts a unit
esstopunit
Stops a unit
esbackupsys
Backs up Event Service resources
esrestoresys
Restores Event Service resources
Event Service
Event Factory
Event Channel
Unit
Maintenance
16-2
esmkchnl
esmkchnl
Name
esmkchnl
Creates Event Channels.
Synopsis
1.
Creating an event channel (for the Event Service)
esmkchnl -g group -c channel ... [-m number] [-l locale] [-autodiscon]
[ssl] [-w] [-host HostName -port PortNum] [-M system]
2.
Creating an event channel (for the Notification Service / JMS)
esmkchnl -g group -c channel ... [-m number] [-l locale] [-autodiscon]
[-ssl] [-w] [-host HostName -port PortNum] [-M system]
[-notify [-persist mode] [-unit unitid] [-tran | -ots] [-ptp]]
Description
Creates event channels (static generation application). This function creates one or more event
channels and gives them a group name.
The following options and parameters can be specified:
Options Common to the Event Service ,Notification Service and JMS
-g group
Specify a group name.
To create a volatile channel, specify a string of up to 64 characters.
To create a persistent operation channel (when this option is specified together with the -persist option),
specify a string of up to 32 characters.
-c channel
Names of the event channels within the group. Multiple assignment is possible.
Specify a string of up to 64 characters.
-m number
Specifies the total number (maximum number) of consumers and suppliers that can connect to the
mixed model event channels contained in the group.
16-3
Chapter 16: Event Service Operation Commands
-l locale
You must set this option if you are using character set conversion. Specify the code for the machine
which is running the event channels.
The code does not need to be set if the supplier and consumer use the same code. However, the event
channel must be set if both the supplier and consumer are using Java.
-autodiscon
When this option is specified, the process to automatically recover connection information remaining in
the event channel is effective if the consumer and supplier are terminated from a statically generated
event channel, without the disconnect command being issued, due to the abnormal termination of an
application etc. The function is only effective if this option is specified.
-ssl
Specify this option when you use SSL with a statically generated event channel. Refer to the Security
System Guide for details.
-w
Specify this option to set up a standby server in cluster service function operation. If this option is
specified, the object reference of the event channel is not registered in the Naming Service. To execute
persistent operation, no data storage area is created in the unit.
-host HostName
Specify a host name (or an IP address) which is the communication path of an event channel in the
system that has multiple IP addresses.
However, do not specify this option when “Corba Host Name” is set (or when “IIOP_hostname” of the
config file (CORBA Service) i.e., the hostname used by CORBA Service is specified) in the Interstage
operating environment definition. (If a hostname other than “Corba Host Name” is specified in this option,
starting of an event channel will fail.)
If this option is omitted, a hostname of “Corba Host Name” will be used when it is set, but the hostname
of the main system will be used if “Corba Host Name” is not set.
-port PortNum
Specify the port number (PortNum) of the communication path of an event channel in a system having
two or more IP addresses.
Specify either of the following for a port number of the CORBA Service.
•
When -ssl option is not specified
"Corba Port Number" in the Interstage operating environment definition ("IIOP_port" of the config
file (CORBA Service))
•
When -ssl option is specified
"SSL Port Number" in the Interstage operating environment definition ("UNO_IIOP_ssl_port" of the
config file (CORBA Service))
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
16-4
esmkchnl
Notification Service and JMS Options
-notify
When this option is specified, an event channel of the notification service or JMS is generated. Specify
this option to generate an event channel using the notification service or JMS. The notification service
function or JMS can only be used if this option is specified.
-persist mode
Specify this option to execute persistent operation on the event channel to be created. With JMS,
specify this option when the Durable Subscription function, event channel make persistent function,
local transaction function, or global transaction function is used. One of the following modes can be
specified:
−
all: Make event data and connection information persistent. (only all can be specified for JMS)
−
con: Make only connection information persistent.
To specify this option, a unit must be previously created using the esmkunit command.
The -notify option must be specified together with this option.
-unit unitid
Specify the unit in which an event channel for persistent operation is to be created. If the -persist
option is specified without this option, the event channel is created in the standard unit.
-tran
Specify this option to execute the local transaction operation in the event channel to be created. This
option must be specified if inter-server linkage is performed or if global transaction operation is not
performed with JMS.
-ots
Specify this option to execute the global transaction operation in the event channel to be created. This
option can create only one event channel group for one unit. However, creating two or more channels in
one event channel group is possible. This event channel cannot be created in the standard unit.
This option is valid when "all" is specified in the -persist option.
-ptp
Set the messaging model to point-to-point, and create an event channel. If this option is omitted, the
notification service creates an event channel using the MultiCast model as a messaging model and JMS
uses the Publish/Subscribe model as a messaging model.
The -notify option must be specified together with this option. In addition, for a persistent operation
(when the -persist option is specified together with this option), the point-to-point model requires a
transaction operation. This means the -tran option or -ots option must be specified together with this
option.
Notes
•
Execute this command with administrator authority.
•
The Naming Service must be active.
•
If Interstage is initialized after this command has been used to create an event channel, use the
esrmchnl command to delete the event channel before initializing Interstage.
If Interstage is initialized without first deleting the event channel, event channels generated before
16-5
Chapter 16: Event Service Operation Commands
initialization must be deleted with the esrmchnl command.
Use the essetcnfchnl command with the –l option to check the list of event channels that have been
created.
•
To execute persistent operation, the Event Service and the unit must be started in advance.
•
Do not include any of the characters listed below in the event channel group name specified with
the -g option or the event channel name specified with the -c option. Otherwise, if the Interstage
Management Console is used to list event channels, processing fails and error message "es39996"
or "es39999" is output. When the Interstage Management Console is used, do not include any of
the following characters in the event channel group name and event channel name.
Invalid characters of the event channel group name
−
Ampersand (&)
−
Equal (=)
−
Asterisk (*)
−
Colon (:)
−
Question mark (?)
−
Comma (,)
−
Smaller-than (<)
Invalid characters of the event channel name
•
−
Ampersand (&)
−
Smaller-than (<)
The -persist, -unit, -tran, -ots, and -ptp options have a dependent or exclusive relation to other
options. Specify these options by referencing the following table.
For example, the -persist option must be specified together with the -notify option, but cannot be
specified together with the -autodiscon option.
Option
Dependent option
Exclusive option
-persist
-notify
-autodiscon
-unit
-notify -persist
-autodiscon
-tran
-notify
-autodiscon -ots
-ots
-notify -persist (all only)
-autodiscon -tran
-ptp
-notify
none
-persist -ptp
-notify -tran
-autodiscon
Or
-notify -ots
16-6
esmkchnl
Examples
Create the event channels of the Event Service "CHNL1" and "CHNL2" while setting the name of the
event channel group to "EVENT1" and setting the maximum number of connected suppliers and
consumers to 100.
esmkchnl -g EVENT1 -c CHNL1 CHNL2
-m 100
Create the event channels of the Notification Service or the JMS "CHNL3" and "CHNL4" while setting
the name of the event channel group to "EVENT2" and setting the maximum number of connected
suppliers and consumers to 100.
esmkchnl -g EVENT2 -c CHNL3 CHNL4
-m 100 -notify
Create the CHNL5 event channel for persistent operation or local transaction operation.
esmkchnl -g EVENT3 -c CHNL5 -notify -persist all –tran
Set the messaging model to point-to-point mode, and create the event channel "CHNL6" for persistent
or local transaction operation.
esmkchnl -g EVENT4 -c CHNL6 -notify -persist all -tran -ptp
16-7
Chapter 16: Event Service Operation Commands
esmkunit
Name
esmkunit
Generates a unit.
Synopsis
esmkunit [-uf unitfile] [-w] [-M system]
Description
This command generates a unit for persistent operation according to the contents of a unit definition file.
The following options and parameters can be specified:
-uf unitfile
Specify the "unitfile" unit definition file. If this option is omitted, a unit is created using a file that has the
def extension in the following directory:
Windows®: C:\Interstage\eswin\etc\def
Solaris OE/Linux: /opt/FJSVes/etc/def
-w
Specify this option to set up a standby server for cluster service function operation.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Coding Format of Unit Definition File
The following shows the format and items of the unit definition file:
The extension of the unit definition file must be "def."
The "esunit01.def" prototype of a unit definition file is stored in the following directory. Edit the prototype
when necessary.
Windows®: C:\Interstage\eswin\etc\def\esunit01.def
Solaris OE/Linux: /opt/FJSVes/etc/def/esunit01.def
16-8
esmkunit
Unit Definition File Format
unitid
unitmode
trandir
tranmax
sysdir
syssize
sysqnum
syswarning
userdir
usersize
userqnum
userwarning
shmmax
=
=
=
=
=
=
=
=
=
=
=
=
unit01
std
D:\NOTIFY_DIR
1024
D:\NOTIFY_DIR
10
100
= 70 - 90
D:\NOTIFY_DIR
30
50
70 - 90
80
Unit Definition File Format
unitid
unitmode
trandir
tranmax
tranmax
sysdir
syssize
sysqnum
syswarning
userdir
usersize
userqnum
userwarning
shmmax
=
=
=
=
=
=
=
=
=
=
=
=
=
unit01
std
/NOTIFY_DIR
100
1024
/NOTIFY_DIR
10
100
= 70 - 90
/NOTIFY_DIR
30
50
70 - 90
80
16-9
Chapter 16: Event Service Operation Commands
Table 16-2 Unit Definition File Items
Item
Description
Default
value
Specifiable range
unitid
Unit name (Only alphanumeric characters can
be used. Upper-case letters are not
distinguished from lower-case letters.)
Not
omissible
1 to 6 (number of
characters)
unitmode
Unit mode
std
std, ext
std: Standard unit
ext: Extended unit
trandir
Specify the directory on the NTFS file system
for storing the transaction file.
Not
omissible
Specify the directory on the normal file system
or raw device for storing the transaction file.
(Fujitsu recommends specification of a raw
device to facilitate rapid processing.)
Note) The following capacity is required:
((tranmax*4)+256+(tranunitmax*2))*16(Kbyte)
The raw device must have been created in
advance.
tranmax
1 to 1024
Number of concurrent transactions
1024
100
tranunitmax
Specify the maximum message size that can
be operated in a transaction by the number of
blocks (one block: 16k bytes (fixed)).
1024
Example) If 1024 is specified
1024*16K bytes = 16M bytes
sysdir
16-10
Directory for storing system files (In the
Windows® system, specify the directory on
the NTFS file system.)
Not
omissible
1 to 4096
esmkunit
Item
Description
Default
value
Specifiable range
syssize
Capacity of system file
Estimate with the following equation as a
guide.
10
1 to 2047
(M byte)
100
4 to 32768
Safety
value: 70
Warning
value: 90
Safety value:
1 to 99 (%)
Warning value:
2 to 100 (%)
(Warning value >
Safety value)
Fixed area + channel use area + proxy use
area + index area
Fixed area: 32K
Channel use area: (n: number of channels)
(16K + (2K * (n-1))) * 1.5
Proxy use area:
((number of consumers + number of
suppliers)/32 + 1) * 16 * 1.5
Index area:
(5 + (Maximum number of messages
accumulated / 340) + 2) * 2 * 16K
sysqnum
Number of system data storage areas
(queues)
Note: The required value must be: number of
channels * 2 + 2 or a larger value
syswarning
Safety value and warning value of system file
capacity. (Delimit the safety value from the
warning value using a hyphen.)
Safety value: Reference value for canceling
the warning state
Warning value: Reference value for setting
the data storage area to the warning state
Note:
When the use rate of a message storage area
reaches a specific value, the message storage
area is set to the warning state (warning
message: es20003). Then, when the use rate
of the message storage area falls to a specific
value, the warning state of the message
storage area is canceled (notification
message: es20004).
userdir
Directory for storing an event data file (In the
Windows® system, specify the directory on
the NTFS file system.)
Not
omissible
16-11
Chapter 16: Event Service Operation Commands
Item
Description
Default
value
Specifiable range
usersize
Capacity of event data file
30
1 to 2047
(M byte)
50
0 to 32768
Estimate with the following equation as a
guide.
Fixed area + message use area
Fixed area: 16K
Message use area:
- 512 bytes or less in an average
(Maximum number of messages accumulated
/32 + 1) * 16K * 1.5
- 1K bytes or less in an average
(Maximum number of messages accumulated
/16 + 1) * 16K * 1.5
- 2K bytes or less in an average
(Maximum number of messages accumulated
/8 + 1) * 16K * 1.5
- More than 2K bytes in an average
((Maximum number of messages accumulated
/8 + 1) * 16K * (message length - 2K) *
Maximum number of messages accumulated)
* 1.5
Note: Estimate after adding a message length
of 1.8 Kbytes to the Message use area of the
equation when using JMS.
userqnum
Number of event data storage areas (queues)
Note:
If only the connection information is to be used
in persistent operation mode, the event data
storage area is not necessary. To use the
connection information and event data in
persistent operation mode, this item must
specify one value for each channel to be
created.
16-12
esmkunit
Item
Description
Default
value
Specifiable range
userwarning
Safety value and warning value of event data
file capacity. (Delimit the safety value from the
warning value using a hyphen.)
Safety
value: 70
Warning
value: 90
Safety value:
1 to 99(%)
Warning value:
2 to 100(%)
(Warning value >
Safety value)
80
1 to 1024(M byte)
Safety value: Reference value for canceling
the warning state
Warning value: Reference value for setting
the data storage area to the warning state
Note:
When the use rate of a message storage area
reaches a specific value, the message storage
area is set to the warning state (warning
message: es20003). Then, when the use rate
of the message storage area falls to a specific
value, the warning state of the message
storage area is canceled (notification
message: es20004).
shmmax
Size of shared memory to be used by unit
Note:
If the maximum length of event data exceeds
2 megabytes, specify the maximum length
multiplied by 4 or a larger value.
Notes
•
Execute this command with administrator authority.
•
Files for two or more units cannot be specified in the storage directory (for transaction, user, or
event data) specified with the unit definition file. Specify separate directories when storing files for
two or more units.
•
Only one standard unit can be created in each system.
•
Do not include any of the characters listed below in the storage directory (for transaction, user, or
event data) specified with the unit definition file. Otherwise, if the Interstage Management Console
is used to list units, processing fails and error message "es39996" or "es39999" is output. When
the Interstage Management Console is used, do not include any of the following characters in the
storage directory.
−
Ampersand (&)
−
Smaller-than (<)
16-13
Chapter 16: Event Service Operation Commands
esmonitor
Name
esmonitor
Displays Event Service status.
Synopsis
1.
Displaying the status of all event channels:
esmonitor [-M system]
2.
Displaying the status of a statically generated event channel:
esmonitor [ -g group [-c channel] ] [-M system]
3.
Displaying the status of a dynamically generated event channel:
esmonitor [ -f [-c channel]|[-id channelID] ] [-M system]
4.
Displaying the status of a unit:
esmonitor [-unit] [-M system]
Description
Uses standard output to display event channel operating status. The available options and parameters
are shown below. If no arguments are specified, it will display the operating status of all active event
channels.
When the -unit option is specified, the unit status is displayed to the standard output. For details about
display contents, refer to Operation Mode and Procedure (Monitoring the Event Communication) in the
Distributed Application Development Guide (CORBA Service Edition). This is provided with Enterprise
Edition and Standard Edition products.
The following options and parameters can be specified:
-g group
Use group to display the status of statically generated event channels.
-f
Use this to display the status of dynamically generated event channels.
-c channel
Use channel to specify the event channels you want to display.
16-14
esmonitor
-id channelID
Specify the ID to display the status of a dynamically generated event channel of the notification service
or the JMS.
-unit
Specify this option to display the unit status.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
The Event Service must be active.
•
When you specify the –unit option, execute this command with administrator authority.
•
If the essecmode command has been used to set the security level to "level2" (administrator's
authority), execute the esmonitor command with the administrator's authority.
Examples
Displays the status of all active event channels.
esmonitor
Displays the status of the statically generated event channel group “group01”.
esmonitor -g group01
Displays the status of dynamically generated event channel “channel02”.
esmonitor -f -c channel02
Displays the status of dynamically generated event channel ID “1” of the notification service or the JMS.
esmonitor –f –id 1
Displays the status of the unit.
esmonitor –unit
16-15
Chapter 16: Event Service Operation Commands
esmonitorchnl
Name
esmonitorchnl
Displays connection information for the event channel.
Synopsis
esmonitorchnl [-l size] [-M system]
Description
Displays the IP addresses (IP address), host names (HOST), connection times (Date) and proxy type
(Kind) for consumers and suppliers connected to the event channel.
Specify the information required in conversational mode after the command has been started.
When information is displayed, connection information that was terminated abnormally can be
recovered.
The following options and parameters can be specified:
-l size
Specify the number of lines of consumer and user information to be displayed. The default value is 20
lines.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
16-16
•
Execute this command with administrator authority.
•
The Event Service must be active.
•
If there is connection data for which commit or rollback has not been issued because the
application terminated abnormally during a local transaction operation, commit processing is
automatically performed. In this case, the event data is processed as follows:
−
The event data that has been sent from the supplier is stored in the event channel.
−
If the messaging model is MultiCast, all event data or event channels are deleted.
−
If the messaging model is point-to-point, all the events that had been received are deleted
from the event channel.
esmonitorchnl
Examples
Operations up to display of connection information:
The following example is of the display of connection information for consumers connected to the
statically generated event channel with group name EVENT1 and event channel name CHNL1.
1.
2.
3.
4.
5.
6.
Run the esmonitorchnl command
esmonitorchnl
Select the start type for the event channel. Enter 1 for a static channel and 2 for a dynamic channel.
Select the channel type.
Select channel type you want to use.
1.static channel 2.dynamic channel > 1
Enter the group name.
Please input group name. > EVENT1
Enter the channel name.
Please input channel name. > CHNL1
Enter the information to be displayed. Enter “1” for consumer or “2” for supplier. Select the
information to be displayed.
Select display information you want to use.
1.consumer 2.supplier > 1
The connection information for the specified event channel is displayed.
Example of display of event channel connection information:
group name
: EVENT1
channel name
: CHNL1
count/all count : 3/3
----------------------------------------------------------------------No. IP address[HOST]
Date
Kind
----------------------------------------------------------------------0001 10.34.169.155[event]
Wed Jun 21 13:49:45 2000 PullSupplier
0002 10.34.169.156[fujitsu]
Wed Jun 21 13:29:25 2000 PullSupplier
0003 10.34.169.156[fujitsu] (2)
Wed Jun 21 13:19:15 2000 PullSupplier
>
16-17
Chapter 16: Event Service Operation Commands
Operations after display of connection information:
After the event channel connection information has been displayed, connection information can be
recovered, next connection information can be displayed, connection information can be redisplayed,
and the command can be terminated.
•
Recovering connection information
To select specific connection information from the information displayed and recover the selected
information, enter “discon -n line number”. The line number is the number indicated by “No.”.
>discon –n line-number
To recover all event channel connection information, enter “discon –all”.
>discon –all
The information displayed is not changed when the connection information is recovered. To display
the current connection information, redisplay the connection information.
•
Display next connection information
To display a greater number of lines, enter “next”. This displays the connection information for the
next number of line numbers specified.
>next
•
Redisplay connection information
To display the current connection information, enter “reload”. The data is redisplayed from Line 1.
>reload
•
Terminate command
To terminate the esmonitorchnl command, enter “quit” or “q”.
>quit
or
>q
16-18
essecmode
essecmode
Name
essecmode
Enhancement of Event Service security
Synopsis
essecmode { -l level | -d } [-M system]
Description
Enhances the security of the Event Service operation command.
The following options and parameters can be specified:
-level
Specify the security level in the Event Service operation command. Allowable levels are as follows:
Specified Value
Explanation
level1 (Initial Value)
Uses the Event Service operation command with the conventional authority.
level2
Uses the Event Service operation command with the administrator's authority
(for enhanced security).
-d
Displays the current security level to the standard output.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
Execute this command while the Event Service is stopped.
16-19
Chapter 16: Event Service Operation Commands
Example
The Event Service operation command is made executable only with the administrator's authority in
order to enhance the security.
essecmode -l level2
16-20
essetcnf
essetcnf
Name
essetcnf
Controls Event Service configuration information.
Synopsis
essetcnf
essetcnf
essetcnf
essetcnf
essetcnf
-r [-M system]
-d [-M system]
-s list [-M system]
-f path [-w] [-M system]
-cr [-M system]
Description
Controls Event Service configuration information.
The following options and parameters can be specified:
-r
Sets configuration information to default values.
-d
Uses standard output to display configuration information.
For details about display contents, refer to Operation Mode and Procedure (Setting Configuration
Information) in the Distributed Application Development Guide (CORBA Service Edition). This is
provided with Enterprise Edition and Standard Edition products.
-s list
Sets configuration information. Specify in a list the options and option settings for the configuration
information. Table 16-3 shows the configuration information that can be specified for Event Service:
Table 16-3 Event Service Configuration Information
Option
Configuration information
Default
Valid range
-schmax
Maximum number of statically generated event channels 50
to be started
1 to 10000
-dchmax
Maximum number of dynamically generated event
channels to be started
50
1 to 10000
-edinit
Initial number of event data items that can be stored in
an event channel
1000
1 to 10000
-edmax
Maximum number of event data items that can be stored 3000
in an event channel
1 to 10000000
16-21
Chapter 16: Event Service Operation Commands
Option
Configuration information
Default
-ltime
Lifetime of event data stored in event channel (seconds) 0
Valid range
1 to 1000000
0: Unlimited
-wtime
Wait time for event data in mixed model (seconds)
40
1 to 1000000
0 : (See Note1)
-dtime
Error detection interval (seconds)
5
1 to 600
-sthinit
Initial number of send threads in push model
4
1 to 100
-sthmax
Maximum number of send threads in push model
100
1 to 100
-coninit
Initial number of consumers who can be connected to
event channel (If statically generated, number of event
channel groups. If dynamically generated, number of
processes.)
50
1 to 1000
-conext
Number of consumers in one extension after initial
number of consumers exceeded
50
1 to 1000
-conenum
Number of extension repeats if consumer number is
extended
100
1 to 100
-supinit
Initial number of suppliers that can connect to event
channel. (If statically generated, number of event
channel groups. If dynamically generated, number of
processes.)
50
1 to 1000
-supext
Number of suppliers in one extension after initial number 50
of suppliers exceeded
1 to 1000
-supenum
Number of extension repeats if supplier number is
extended
100
1 to 100
-discon
Call to suppliers and consumers for disconnect method
when event channel terminates. (yes: Calls for
disconnect, then event channel terminates.)
yes
yes,no
-oneway
In push model, do not wait for response from consumer. no
(yes: Do not wait.)
yes,no
-chksend
In push model when a communication error is issued for yes
a consumer, reroute transmissions to the consumer.
(Valid only if “-oneway no” is specified.)
yes,no
-logsize
Size of log files used for error information output (in
Kilobytes)
1024
1 to 512000
-loglevel
Error information level for log output
1
1,2,3
256
1 to 512
1: Error events only
2: List of consumers who did not receive data because it
was deleted due to expiry of lifetime
3: Information in level 2 and deleted event data contents
-logdump
16-22
Output size of log output event data (Valid only if
essetcnf
Option
Configuration information
Default
Valid range
“loglevel 3” specified. In bytes.)
-gtrnmax
Number of global transactions that can be concurrently
executed
256
1 to 1024
-ltrntime
Time-out period (seconds) of local transaction
300
1 to 1000000
-2pctime
2-phase commit time-out monitor time (seconds)
60
1 to 20000
-retrytime
Retry interval (seconds) for recovery
30
1 to 1000
-retrymax
Number of retry operations for recovery
60
1 to 100
-pltime
Existing time (seconds) of event data stored in event
channel at persistent operation of event data and
connection information
0
1 to2000000000
Error return mode when there is no consumer
connection (See Note2)
no
yes,no
-chkcon
0 : Unlimited
yes: Return with error
no: Normal end
If “yes” is specified and there is no consumer connected
to the event channel when the Push method is issued to
the channel, control returns with an error. When the
Push method is issued, the following exception is
reported:
Exception information: BAD_OPERATION
Minor code: 0x464a09e9
-dcache
Number of memory caches of event data at persistent
operation
1000
1 to 100000
-autostart
Specifies whether to automatically activate the event
channel when the event service starts.
yes
yes,no
yes: Activate automatically
no: Do not activate automatically
Note 1) Dependent on the value of period_receive_timeout in the CORBA Service operating
environment file (config).
Note 2) This mode is effective in the Mixed and MultiCast models.
-f path
To make an event channel persistent for cluster service function operation, specify the path of the
shared disk in which the file related to the persistent information is to be stored.
-w
Specify this option to set up the standby server.
-cr
Restores the cluster environment settings to the ordinary environment settings.
16-23
Chapter 16: Event Service Operation Commands
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
These commands will take effect after rebooting the Event Service.
•
When changing the Event Service environment during persistent operation by using this command,
only the following configuration information can be changed. The changed configuration information
becomes valid after re-starting the Event Service.
−
-wtime
−
-dtime
−
-logsize
−
-loglevel
−
-logdump
−
-ltrntime
−
-2pctime
−
-chkcon
When the configuration information other than the above is changed, re-create an event channel in the
following procedure.
16-24
1.
Stop the event channel (esstopchnl)
2.
Delete the event channel (esrmchnl)
3.
Stop the unit (esstopunit)
Note: Only for the extended unit
4.
Stop the Event Service (esstop)
5.
Set the configuration information (essetcnf)
6.
Start the Event Service (esstart)
7.
Start the unit (esstartunit)
Note: only for the extended unit
8.
Create an event channel (esmkchnl)
9.
Start the event channel (esstartchnl)
•
The -f, -cr, and -w options can be used only when the Event Service is stopped and the unit is not
set up.
•
To change the environment by -f and -w options after the cluster environment is constructed, delete
the event channel and unit to stop the Event Service, and then return to an ordinary environment
setting with the -cr option before changing the environment.
essetcnf
•
To delete the event channel or unit in the cluster environment, delete the standby node first.
Example
Sets up the inventory service environment, specifying 100 as the maximum number of statically
generated event channels and 200 as the maximum number of dynamically generated event channels.
essetcnf -s -schmax 100 -dchmax 200
16-25
Chapter 16: Event Service Operation Commands
essetcnfchnl
Name
essetcnfchnl
Displays and sets event channel operating environments.
Synopsis
1.
List channels and groups
essetcnfchnl -g group
2.
-s list
[-M system]
Display operating environments for group(s)
essetcnfchnl [ -g group ]
4.
-s list [-M system]
Sets the operating environment for group(s)
essetcnfchnl -g group
3.
-c channel
-d [-M system]
Lists group names
essetcnfchnl –l [-M system]
Description
Sets event channel operating environments. You can set event channel environments either on a group
or individual basis.
The following options and parameters can be specified:
-g group
Specifies the event channels’ group name.
-c channel
Specifies event channel names.
-s list
Sets the operating environment for an event channel or for an entire event channel group. Specify in a
list the options and option settings that indicate the operating environment settings. Refer to Table 16-4
for details of the items to be set.
-d
Uses standard output to display operating environment contents for event channels contained in groups
specified by –g. If no group name is specified, it will display event channel operating environments for
all groups registered in the system.
16-26
essetcnfchnl
For details about display contents, to Operation Mode and Procedure (Event Channel Static Generation
and Operation - Operating and Grouping Event Channels) in the Distributed Application Development
Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard Edition products.
-l
Lists group names.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Operating environment settings items
Table 16-4 Operating Environment Settings Items
Option
Operating environment items
Default
(See Note1)
Valid range
-edinit
Initial number of event data items that can be stored in
an event channel
Default
1 to 10000
-edmax
Maximum number of event data items that can be
stored in an event channel
Default
1 to 10000000
-type
Event channel model
- (none)
push
pull
mixed
none (not
specified)
(See Note2)
-ltime
Lifetime of event data stored in event channel
(seconds)
Default
1 to 1000000
-sthinit
Initial number of send threads in push model (See
Note3)
Default
1 to 100
-sthmax
Maximum number of send threads in push model (See
Note3)
Default
1 to 100
-coninit
Initial number of consumers who can be connected to
event channel group (See Note3)
Default
1 to 1000
-conext
Number of consumers in one extension after initial
number of consumers exceeded (See Note3)
Default
1 to 1000
-conenum
Number of extension repeats if consumer number is
extended (See Note3)
Default
1 to 100
-supinit
Initial number of suppliers that can connect to event
channel group. (See Note3)
Default
1 to 1000
-supext
Number of suppliers in one extension after initial
Default
1 to 1000
0: Unlimited
16-27
Chapter 16: Event Service Operation Commands
Option
Operating environment items
Default
(See Note1)
Valid range
number of suppliers exceeded (See Note3)
-supenum
Number of extension repeats if supplier number is
extended (See Note3)
Default
-discon
Call to suppliers and consumers for disconnect method Default
when event channel terminates. (yes: Calls for
disconnect, then event channel terminates.)
yes,no
-oneway
In push model, do not wait for response from consumer. Default
(yes: Do not wait.)
yes,no
-chksend
In push model when a communication error is issued
Default
for a consumer, reroute transmissions to the consumer.
(Valid only if “-oneway no” is specified.)
yes,no
-wtime
Wait time (seconds) of event data of Mixed model
1 to 1000000
Default
1 to 100
0: (See Note4)
-ltrntime
Time-out period (seconds) of local transaction
-pltime
Existing time (seconds) of event data stored in the
Default
event channel at persistent operation of event data and
connection information
-chkcon
Control return mode when there is no consumer
connection (See Note5)
Default
1 to 1000000
1 to 2000000000
0: Unlimited
Default
yes,no
yes: Return with error
no: Normal end
If “yes” is specified and there is no consumer
connected to the event channel when the Push method
is issued to a statically generated channel, control
returns with an error. When the Push method is issued,
the following exception is reported:
Exception information: BAD_OPERATION
Minor code: 0x464a09e9
-dcache
Number of memory caches of event data at persistent
operation
Default
1 to 100000
-autostart
Specifies whether to automatically activate the event
channel when the event service starts.
Default
yes,no
yes: Activate automatically
no: Do not activate automatically
16-28
Note 1:
essetcnf.
If the default is used, the Event Service configuration information is applied. Refer to
Note 2:
Only “mixed” and “none” are valid for the notification service or JMS(-notify specified).
Note 3:
specified).
Can be set only for an entire channel group (cannot be specified if “-c channel” is
essetcnfchnl
Note 4:
Dependent on the value of period_receive_timeout in the CORBA Service operating
environment file (config).
Note 5:
This mode is effective in the Mixed and MultiCast models.
Notes
•
Execute this command with administrator authority.
•
Stop event channels before setting work environments.
•
To change the Event Service environment during persistent operation by using this command, only
the following operation environment items can be changed. The changed configuration information
becomes valid after re-starting the Event Service.
−
-wtime
−
-ltrntime
−
-chkcon
When an operating environment item other than the above is changed, re-create an event channel in
the following procedure.
1.
Stop the event channel (esstopchnl)
2.
Delete the event channel (esrmchnl)
3.
Create an event channel (esmkchnl)
4.
Set the operating environment of the event channel (essetcnfchnl)
5.
Start the event channel (esstartchnl)
Examples
In the group “GROUP”, this sets the data storage initial value to 1,000 and the maximum to 10,000.
essetcnfchnl -g GROUP -s -edinit 1000 -edmax 10000
In the group “GROUP”, this makes the event channel “EVENT1” a pull model.
essetcnfchnl -g GROUP -c EVENT1
-s -type pull
16-29
Chapter 16: Event Service Operation Commands
essetup
Name
essetup
Sets up an Event Service.
Synopsis
essetup
ssl]]
[ -f [-p number ] [-m number ] [ -l locale
] [-autodiscon] ] [-
[-M system]
Description
Sets up an Event Service in the system.
The following options and parameters can be specified:
-f
Sets up an Event factory. If an Event Service has not been set up, this will set one up.
-p number
Specify the maximum number of processes for an event channel that can operate on the system when
an event factory is used. A value from 1 to 256 can be specified. The default value of this option is 2.
-m number
Specify the total number of consumers and suppliers (i.e., the maximum number of connections) to be
connected to a process unit in which the event channel of the dynamically generated Mix model is
operating. A value from 1 to 9999 can be specified. The default value of this option is 16.
-l locale
You must set this option if you are using character set conversion. Specify the code type for the machine
which is running the dynamically generated event channels.
The code does not need to be set if the supplier and consumer use the same code.
-autodiscon
Specify this option to make the function to automatically recover connection information remaining in the
event channel when consumers and suppliers are terminated from a dynamically generated event
channel without the disconnect method being issued, due to abnormal termination of an application
program etc.
-ssl
Specify this option when you use SSL with a statically generated event channel. Refer to the Security
System Guide for details.
16-30
essetup
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
When using the terminal service in Windows® 2000 Server or Windows® 2000 Advanced Server,
before executing this command, execute the following command to switch to installation mode:
−
CHANGE USER/INSTALL
After executing this command, execute the following command to switch from installation to
application execution mode:
−
CHANGE USER/EXECUTE
Example
Sets up an Event factory. In the following example the maximum number of event channel processes is
set to 4, the maximum number of connected consumer/suppliers is set to 50, and the automatic
recovery of connection information is set to "on". If an Event Service has not been set up, this will set
one up.
essetup -f -p 4 -m 50 –autodiscon
16-31
Chapter 16: Event Service Operation Commands
esstart
Name
esstart
Starts an Event Service.
Synopsis
esstart [-M system]
Description
Starts an Event Service. The Event Service controls the starting of event channels and event factories
running on its machine. The standard unit is also started if the standard unit was created for persistent
channel operation.
The following options and parameters can be specified:
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The Naming Service must be active.
•
The Event Service can be also started using “Service” from “Control Panel”. Select “EventService”
and push “Start”.
Example
Start an Event Service.
esstart
16-32
esstartchnl
esstartchnl
Name
esstartchnl
Starts Event Channels.
Synopsis
esstartchnl -g group
[-r mode ]
[-M system]
Description
Starts event channels. To start the event channels, specify their group name.
The following options and parameters can be specified:
-g group
Specifies the group name of the event channels you want to start.
-r mode
Forced to successfully start a channel if a recovery in the Database Linkage Service fails with error
message es11017.
One of the following modes can be specified:
r: Forcibly roll back an unsolved transaction.
c: Forcibly commit an unsolved transaction.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The Naming Service must be active.
•
The Event Service must be active.
Example
Starts event channel group “GROUP”.
esstartchnl -g GROUP
16-33
Chapter 16: Event Service Operation Commands
esstartfctry
Name
esstartfctry
Starts an event factory.
Synopsis
esstartfctry
[-M system]
Description
Starts an event factory.
The following options and parameters can be specified:
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The Event Service must be active.
•
Event Factory can be also started using “Service” from “Control Panel”. Select “Eventfactory” and
push “Start”.
Example
Starts an event factory.
esstartfctry
16-34
esstartunit
esstartunit
Name
esstartunit
Starts a unit.
Synopsis
esstartunit
-unit
unitid
[-M system]
Description
This command starts a unit. Use the unit name specified when the unit was generated to start the unit.
The following options and parameters can be specified:
-unit unitid
Specify the unit name (unitid) of the unit to be started.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The Event Service must be active.
Example
Starting a unit with unit name "UNIT"
esstartunit -unit UNIT
16-35
Chapter 16: Event Service Operation Commands
esstop
Name
esstop
Stops an Event Service
Synopsis
esstop
[ -o
orderly
]
[-M system]
Description
Stops an Event Service.
The following options and parameters can be specified:
-o orderly
Specifies the stopping method. If you do not input a parameter, the system will assume on.
on: Stops in inhibited mode.
off: Forced stop.
When stopping in inhibited mode, the Event Service will not stop while there is still event data in the
event channels. It will stop after the data is deleted, either after having been delivered to consumers, or
after exceeding its lifetime.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
Set “0 (unlimited)” in “Lifetime of the event data which accumulates in the event channel” (essetcnf
command ltime option or essetcnfchnl command ltime option), and execute this command in the
forced ending mode while data is being accumulated in the event channel. For details, refer to the
essetcnf and essetcnfchnl commands and to EventFactory interface (or EventFactory class).
The esmonitor command can be used to check the event data lifetime setting and the accumulated
data status. For details, refer to the esmonitor command and the Distributed Application
Development Guide (CORBA Service Edition). This is provided with Enterprise Edition and
Standard Edition products.
16-36
esstop
•
If the Event Service is stopped again after it has already been stopped in inhibited mode, the error
message es10305 may be output even if the Event Service is normally stopped. For more
information, refer to Messages.
•
The Event Service can be also stopped using “Service” from “Control Panel”. Select “EventService”
and push “Stop”.
Example
Stop an Event Service forcibly.
esstop -o off
16-37
Chapter 16: Event Service Operation Commands
esstopchnl
Name
esstopchnl
Stops Event Channels.
Synopsis
esstopchnl
-g group
[ -c
channel ] [ -o
orderly ] [-M system]
Description
Stops event channels.
The following options and parameters can be specified:
-g group
Specifies the group name of the event channels you want to stop.
-c channel
Specifies which event channel to stop.
-o orderly
Specifies the stopping method. If you do not input a parameter, the system will assume on.
on: Stops in inhibited mode.
off: Forced stop.
When stopping in inhibited mode the event channels will not stop while they still contain event data.
They will stop after the data is deleted, either after having been delivered to consumers, or after
exceeding its lifetime.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
16-38
esstopchnl
Notes
•
Execute this command with administrator authority.
•
The Naming Service must be active.
•
The Event Service must be active.
•
Set “0 (unlimited)” in “Lifetime of the event data which accumulates in the event channel” (essetcnf
command ltime option or essetcnfchnl command ltime option), and execute this command in the
forced ending mode while data is being accumulated in the event channel. For details, refer to the
essetcnf and essetcnfchnl commands and to EventFactory interface (or EventFactory class).
The esmonitor command can be used to check the event data lifetime and the data accumulation
status. For details, refer the esmonitor command and to information about Event Service
application development in the Distributed Application Development Guide (CORBA Service
Edition). This is provided with Enterprise Edition and Standard Edition products.
Examples
Stops event channels with the group name “GROUP” forcibly.
esstopchnl -g GROUP -o off
In the group “GROUP”, it only stops event channel “CHNL2” forcibly.
esstopchnl -g GROUP -c CHNL2 -o off
16-39
Chapter 16: Event Service Operation Commands
esstopfctry
Name
esstopfctry
Stops an event factory.
Synopsis
esstopfctry
[{[ -c channel |[-id channelID]} ] [ -o
orderly
] [-M system]
Description
Stops an event factory.
The following options and parameters can be specified:
-c channel
Specifies which Event Service event channel to stop.
-id channelID
Specifies the ID of the Notification Service or the JMS event channel to stop.
-o orderly
Specifies the stopping method. If you do not input a parameter, the system will assume on.
on: Stops in inhibited mode.
off: Forced stop.
When stopping in inhibited mode, the event factory will not stop while there is still event data in the
event channels. It will stop after the data is deleted, either after having been delivered to consumers, or
after exceeding its lifetime.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
16-40
esstopfctry
Notes
•
Execute this command with administrator authority.
•
The Event Service must be active.
•
Set “0 (unlimited)” in “Lifetime of the event data which accumulates in the event channel” (essetcnf
command ltime option or essetcnfchnl command ltime option), and execute this command in the
forced ending mode while data is being accumulated in the event channel. For details, refer to the
essetcnf and essetcnfchnl commands and to information about the EventFactory interface (or
EventFactory class).
The esmonitor command can be used to check the event data lifetime and the data accumulation
status. For details, refer to the esmonitor command and the Distributed Application Development
Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard Edition
products.
Examples
Stop an Event factory forcibly.
esstopfctry -o off
Stop dynamically generated event channel “CHNL1” forcibly.
esstopfctry -c CHNL1 -o off
Stop dynamically generated event channel ID “1” of the notification service or JMS forcibly.
esstopfctry –id 1 -o off
16-41
Chapter 16: Event Service Operation Commands
esstopunit
Name
esstopunit
Stops a unit.
Synopsis
esstopunit
-unit
unitid
[-o orderly]
[-M system]
Description
This command stops a unit.
The following options and parameters can be specified:
-unit unitid
Specify the unit name (unitid) of the unit to be stopped. The unit name unitid can be checked with the
esmonitor command.
-o orderly
Specifies the stopping method. If you do not input a parameter, the system will assume on.
on: Stops in inhibited mode.
off: Forced stop.
When a unit is stopped in block mode during the execution of commit processing in global transaction
operation, terminating processing is not performed until the commit processing is completed. The
terminating processing starts at a point where the commit processing is completed.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
16-42
•
Execute this command with administrator authority.
•
This command can be executed when all the events assigned to the unit are stopped.
esstopunit
Example
Stop the unit "UNIT" forcibly.
esstopunit -unit UNIT -o off
16-43
Chapter 16: Event Service Operation Commands
esrmchnl
Name
esrmchnl
Deletes Event Channels.
Synopsis
esrmchnl
-g
group
[-M system]
Description
Deletes event channels. Delete event channels by specifying their group names.
The following options and parameters can be specified:
-g group
Specifies the group name of the event channels you want to delete.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
The Naming Service must be active.
•
For an event channel in persistent operation, execute this command in states where the unit
belonging to the event channel is started.
•
If Interstage is initialized after the esmkchnl command has been used to create an event channel,
use this command to delete the channel before initialization. If Interstage is initialized before the
event channel is deleted, this command must be used to delete the event channel that was created
before initialization. Use the essetcnfchn command to check the list of event channels that have
been created.
Example
Delete the group “GROUP”.
esrmchnl -g GROUP
16-44
esrmunit
esrmunit
Name
esrmunit
Deletes a unit.
Synopsis
esrmunit
[-unit
unitid]
[-M system]
Description
This command deletes a unit in persistent operation.
The following options and parameters can be specified:
-unit unitid
Specify the unit name (unitid) of the unit to be deleted. If this option is omitted, all the units are deleted.
The unit name unitid can be checked with the esmonitor command.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
This command can be executed when the unit is stopping and has no event channels.
Example
Delete the unit "UNIT."
esrmunit -unit UNIT
16-45
Chapter 16: Event Service Operation Commands
esunsetup
Name
esunsetup
Deletes an Event Service.
Synopsis
esunsetup
[ -f ]
[-M system]
Description
Deletes an Event Service from the system. If an event factory has been set up and you delete an Event
Service, both of them will be deleted from the system.
The following options and parameters can be specified:
-f
Deletes an Event factory from the system.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with the Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
When using the terminal service in Windows® 2000 Server or Windows® 2000 Advanced Server,
before executing this command, execute the following command to switch to installation mode:
CHANGE USER/INSTALL
After executing this command, execute the following command to switch from installation to
application execution mode:
CHANGE USER/EXECUTE
Example
Delete an Event Service from the system.
esunsetup
16-46
Chapter 17
Portable-ORB Environment Setup
Commands
Portable-ORB provides a command (porbeditenv) that is used to set up the environment.
This chapter details the porbeditenv command.
Note
The Portable-ORB environment setup command can be used in the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus.
17-1
Chapter 17: Portable-ORB Environment Setup Commands
porbeditenv
Name
porbeditenv
Edit environment file
Synopsis
If you are going to use porbeditenv with commands:
java -classpath %PORB_HOME%\bin\porbeditenv.jar;%CLASSPATH% porbeditenv
If you are going to use porbeditenv with commands:
java -classpath $CLASSPATH:$PORB_HOME/bin/porbeditenv.jar porbeditenv
If you are going to use porbeditenv with an applet:
<applet code=“porbeditenv.class” ARCHIVE=“porbeditenv.jar” width=500
height=460>
<PARAM Name=“PORB_CGI_PATH” VALUE=“CGI storage folder”> </applet>
Notes
17-2
•
The environment variable PORB_HOME is the install directory for Portable-ORB.
•
If the environment variable CLASSPATH includes space characters, as in the string “Program Files”,
enclose it in double quotation marks as follows: “%CLASSPATH%”.
•
For the CGI storage folder, specify the CGI file storage location relative path from Web root.
porbeditenv
Description
The porbeditenv command is used to edit the environment file when Portable-ORB is to be run. When
the porbeditenv command is started up, the window shown in Figure 17-1 will be displayed.
Figure 17-1 Portable ORB Environment Editor Window
Open
Click Open to read in and display the operating environment file from the specified storage location.
When Open is clicked, the window shown below is displayed. Use this window to specify the storage
location.
For the storage location directory, specify the storage location of the operating environment files.
If commands use the files, omit the etc subdirectory from the file system path format when specifying the
directory path. To open the operating environment files stored under C:\Interstage\PORB\etc in
Windows® systems, specify C:\Interstage\PORB as the storage location directory.
17-3
Chapter 17: Portable-ORB Environment Setup Commands
If applets use the files, omit etc from the URL path format when specifying the URL path. To open the
operating environment files stored under the URL path http://www.xxx.yy.zz/PORB/etc, specify
http://www.xxx.yy.zz/PORB as the storage location directory. (Figure 17-2)
Figure 17-2 Set URL(Directory Path) Window
New
Click the New button if you want to create a new environment file. When you have edited the
environment file, another window will appear, asking you to confirm where you want to store it. The new
environment file is then created.
Click Save to save the new operating environment file. This displays the same storage location
specification window as the one displayed when Open is clicked. Specify the storage location directory
in the format described above under Open. This format is valid only when commands use the files.
Save
Click this button to save the environment file displayed in the window.
Save As
Click this button to save the environment file displayed in the window, to a different directory. A storage
location specification window will appear, like the one that appears when Open is clicked. The
environment file is then saved to the directory you have specified displayed in this window.
The storage directory specification format is the same as described above under Open. This format is
valid only when commands use the files.
Path
This displays the name of the storage directory for the environment file currently displayed. The
environment file is stored in the sub-directory etc under the directory name shown here.
Max Connection
Specify the maximum number of connections from the client to the server machine.
Max Request
Specify the maximum number of requests that can be issued concurrently by the client application to the
same server.
TimeOut
Specify the response time (in seconds) until the server method is returned to the client. The value
specified here, multiplied by 5, is the actual response time.
Get log
Put a check in this box if you want to keep a log.
17-4
porbeditenv
LogFile Size
If you have not checked Get log, this will be invalid. Specify the maximum size of the log file, in KB.
Port (logging)
If you have not checked Get log, this will be invalid. Specify the port number to be used for keeping the
log.
Directory
If you have not checked Get log, this will be invalid. Specify the storage directory to be used if the log is
to be stored in the client.
This specification is valid only if the client application is run as an applet. If the client application is run
as an application, logs are stored in the var directory under the Portable- ORB install directory.
Initialize
Click this button if you want to restore the environment file to its initial state.
Host
Specify the host name where the Naming Service and Interface Repository to be used will be started up.
Port (Initial Host)
Specify the port number where the Naming Service and Interface Repository will be used.
Add
Add the information you input for Host and Port to Host list.
Remove
Remove the selected host name and port number from the Host list box.
Up
Substitute the selected host name and port number in the Host list box for the information on the line
above (i.e. move it one line up). Set search order to “upwards”.
Down
Substitute the selected host name and port number in the Host list box for the information on the line
below (that is, move it one line down). Set search order to “downwards”.
Host list
Portable-ORB searches for the host where the Naming Service has been started up, among the hosts
displayed in the Host list box. In operation, the search is carried out in order from the host displayed at
the top.
17-5
Chapter 17: Portable-ORB Environment Setup Commands
Notes
•
porbeditenv.jar is stored in the bin directory under the Portable-ORB install directory.
•
Execute this command with administrator authority.
•
If changes are made to the operating environment, but the changes are not saved when New or
Open is selected, the save changes confirmation window (Figure 17-3) is displayed.
Figure 17-3 Save Changes Confirmation Window
Subsequent processing depends on which button is selected, as follows:
YES: The changes are saved, then the New or Open processing proceeds.
NO: The changes are not saved, and the New or Open processing proceeds.
CANCEL: The changes are not saved, and the display reverts to the screen status before New or
Open was selected.
•
If this command is executed under Solaris OE, the following warning may be displayed, but
operations are not affected:
Warning
Name:slist
Class:XmList
Invalid item(s) to delete.
Setting CGI file
When editing the environment file on Web server for applet employment, you must set CGI in HTML
files and on Web server. Refer to the document of the Web server as for setting CGI on Web server.
Sample programs, an HTML file porbeditenv.html and a CGI file writeFile.cgi, are stored in “<PortableORB installation directory>/bin”.
When using porbeditenv.html and writeFile.cgi, change them to suit your environment as follows.
17-6
porbeditenv
(1) Changing description in HTML
You need to change “<param name = “PORB_CGI_PATH” value = “/cgi-bin/”>“ in porbeditenv.html .
•
When the storage directory of writeFile.cgi is located under HTML document root directory, change
it to relative directory from HTML document root directory.
•
When the storage directory of writeFile.cgi is located as default CGI directory on Web server,
change it to relative directory from Web root directory.
For example, if the directory structure is as follows:
/www_HOME (*1) -+- cgi-bin (*2)
+- doc (*3) -+- sample
*1) WWW_HOME: The install directory for Web server
*2) WWW_HOME/cgi-bin: The CGI script storage directory
*3) WWW_HOME/doc: The HTML document root storage directory
(It is called the document route or access the top.)
•
When the storage directory of writeFile.cgi is default CGI directory on Web server, change it to the
following.
<param name = “PORB_CGI_PATH” value = “/cgi-bin/”>
•
When the storage directory of writeFile.cgi is located on “doc/sample”, change it to the following.
<param name = “PORB_CGI_PATH” value = “/sample”>
(2) Changing description in CGI
You need to change “DOCUMENTROOT=“ in writeFile.cgi to “DOCUMENTROOT=<absolute directory
of HTML document root directory>“. For example, if the HTML document root directory is
“WWW_HOME/doc”, describe “DOCUMENTROOT=WWW_HOME/doc”.
Note: On some Web servers it may be necessary to set the directory of the CGI file to allow CGI
execution.
(3) Changing permission of the operating environment file
When setting up the operating environment in the applet operation, the Portable-ORB operating
environment file may not be accessible with the permission with which CGI is working. Consequently,
the setting up of the operating environment could fail. In this case, it is necessary to make the owner of
the operating environment setup file agree with the permission with which CGI is working by using the
chown command beforehand. The permission (user ID, group ID) with which CGI is working is set up
by the environment definition of the Web server.
For example, when the permission (<user ID>:<group ID>) with which CGI is working is set to
nobody:nobody; the owner of the operating environment file can be changed by using the following
commands on the directory where the operating environment file is stored.
chown nobody:nobody config initial_hosts
17-7
Chapter 17: Portable-ORB Environment Setup Commands
Notes
Only execute a chown command with the permission of the administrator.
Return the permission back to the original permission of the owner after the operating environment is
set up. The owner's original permission is such that (<user ID>:<group ID>) is root:sys.
Remarks
(1) When Using Command
When using command, creating the following batch file is recommended.
Example
set PORB_HOME=C:\Interstage\PORB
java -classpath "%PORB_HOME%"\bin\porbeditenv.jar;"%CLASSPATH%" porbeditenv
*) Set PORB_HOME as the installation directory of Portable-ORB.
The batch file described above is porbeditenv.bat under “C:\Interstage\PORB\bin”.
PORB_HOME=/opt/FJSVporb; export PORB_HOME
java -classpath $PORB_HOME/bin/porbeditenv.jar:$CLASSPATH porbeditenv
*) Set PORB_HOME as the installation directory of Portable-ORB.
The batch file described above is porbeditenv.sh under “/opt/FJSVporb/bin”.
(2) Log Files
If you specify Get log and then execute the applet, the log files will be stored with the name xxxyyy.log
and xxxyyy.old (where xxx is the applet class name specified in HTML, and yyy is the host name of the
client machine on which the applet was executed) under the directory you specified for Logging
directory.
If digital signing has not been implemented, or if the path is wrong, the log file will not be created.
Messages
The execution result of the command is output to the screen where the command was executed.
See the Messages for the content of the message.
17-8
Chapter 18
Performance Analysis Monitoring
Commands
This chapter details the Performance Analysis Monitoring commands.
The Performance Analysis Monitoring command can be used with the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus.
Note
Only the following commands are available for Plus:
−
−
−
−
−
−
−
−
ispmakeenv
ispdeleteenv
ispstart
ispstop
ispstatus
ispreport
ispsetagt
ispunsetagt
18-1
Chapter 18: Performance Analysis Monitoring Commands
ispmakeenv
Name
ispmakeenv
Create performance monitoring environment and start up performance monitoring logger.
Synopsis
ispmakeenv [-M system-name] [-m size] [-i interval1] [-r interval2] [-d
directory]
Description
This command creates the performance monitoring environment and starts up the performance
monitoring logger.
The options and arguments of the ispmakeenv command are explained below.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-m size
Specify the shared memory size. Use spaces as delimiters between –m and size. Specify the shared
memory size in MB. If you fail to specify a value, it will default to 1MB. The minimum value that can be
specified is 1, and the maximum value is the maximum value (in MB) for the size of the shared memory
defined by the system, or 2046, whichever is the smaller. The performance monitoring tool uses the
shared memory to log performance information. Before you make your specification, work out the
amount of shared memory needed from the amount of performance information to be logged. Refer to
the Tuning Guide for instructions on estimating the amount of performance information.
-i interval1
Specify the time interval for which the performance information is held in the performance log files. The
interval can be specified in hours or minutes. The following values can be set:
Hours:
1, 2, 3, 4 (1 to 4 hours)
Minutes:
1m, 5m, 10m, 20m, 30m (1, 5, 10, 20 or 30 minutes)
The default is 1 hour.
-r interval2
Time interval for real-time monitoring.
18-2
ispmakeenv
Specify the time interval to collect performance information to be reported to the network manager.
Specify the time interval in the range of 1 to 60 minutes.
If this operand is omitted, the default value is 5 minutes.
-d directory
Specify the absolute pathname of the folder where performance log files are created. The default is the
folder specified by the ISP_LOG environment variable. If a folder name is not specified by this
argument (or in the ISP_LOG environment variable), the following default directory names are used.
C:\INTERSTAGE\td\isp\log
/opt/FSUNtd/isp/log
/opt/FJSVtd/isp/log
Performance log files are created in the specified folder and with the following naming style:
Performance log file name
ispYYYYMMDD.log
where, YYYYMMDD is the file creation date.
YYYY:
Western year
MM:
Month (01 to 12)
DD:
Day (01 to 31)
Notes
•
Only system administrators are authorized to execute this command.
•
Execute this command before you use the ispstart command and start the WorkUnit of the target
object that you are going to monitor the performance of.
•
Do not delete performance log files after the ispmakeenv command is executed. If deleted, the
performance information may not be saved correctly. If performance log files are to be deleted, use
the ispdeleteenv command.
18-3
Chapter 18: Performance Analysis Monitoring Commands
Examples
Use this command to specify a folder name and create a performance monitoring environment:
ispmakeenv –d c:\temp\isplog
Use this command to create a performance monitoring environment in which the real-time monitoring
function is used:
ispmakeenv –r 10
Acquire 5M of shared memory and create the performance monitoring environment:
ispmakeenv –m 5
Acquire 1M of shared memory and create a performance monitoring environment that retains the
performance information for a period of 10 minutes.
ispmakeenv -i 10m
18-4
ispdeleteenv
ispdeleteenv
Name
ispdeleteenv
Stop performance monitoring logger and delete performance monitoring environment.
Synopsis
ispdeleteenv [-M system-name]
Description
This command stops the performance monitoring logger and deletes the performance monitoring
environment.
The options and arguments of the ispdeleteenv command are explained below.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only system administrators are authorized to execute this command.
•
Once you have deleted the performance monitoring environment and stopped the performance
monitoring logger, performance monitoring cannot be carried out. If you want to reinstate
performance monitoring, re-create the performance monitoring environment and restart the
performance monitoring logger to restart Interstage.
•
The performance monitoring logger should not be stopped while performance monitoring is in
progress. If the performance monitoring logger is stopped while performance monitoring is in
progress, then no further performance data will be logged.
Example
To delete the performance monitoring environment and stop the performance monitoring logger:
Ispdeleteenv
18-5
Chapter 18: Performance Analysis Monitoring Commands
ispstart
Name
ispstart
Start performance monitoring
Synopsis
ispstart [-M system-name] -f FileName | -o ObjectName
Description
This command starts performance monitoring. The argument of the ispstart command is explained
below.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
-f FileName
The specification file for performance surveillance which described the candidate for performance
measurement is specified. The following can be specified to be a candidate for performance
measurement.
Note: For the specification file for performance monitoring, refer to "Definition Files Used at Operation of
Performance Monitoring Tool" in the Interstage Operator's Guide.
•
Object name of transaction application
•
Object name of wrapper
•
EJB application name
•
Light EJB container name
•
Implementation repository ID of CORBA application.
This option needs to specify -o option, when omitting. The candidate for performance surveillance can
be specified to a total of 1000 pieces in a file.
For Plus, only an EJB application name and Light EJB container name can be specified.
18-6
ispstart
-o ObjectName
This is used to specify the object names for the transaction application or wrapper objects to be
measured. Use spaces as delimiters between –o and ObjectName. Between 1 and 1000 object names
can be specified.
When specifying more than one object name, use spaces as delimiters between them. If this option is
omitted, the -f option must be specified.
This option is available for the Enterprise Edition and Standard Edition only.
Notes
•
Only system administrators are authorized to execute this command.
•
Do not start performance monitoring until you have used the ispmakeenv command to create the
performance monitoring environment. If the performance monitoring environment has not been
created, performance monitoring will fail to start.
•
Performance monitoring fails to start if the specified object is not registered.
Examples
The following examples show how performance monitoring is started.
When there is 1 object:
ispstart
-o object001
When there are 3 objects:
ispstart
-o object001 object002 object003
When the specification file for performance monitoring is specified:
ispstart
-f objfile
18-7
Chapter 18: Performance Analysis Monitoring Commands
ispstop
Name
ispstop
Stop performance monitoring
Synopsis
ispstop [-M system-name]
The argument of the ispstop command is explained below.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Description
This command stops performance monitoring.
Note
Only system administrators are authorized to execute this command.
Example
To stop performance monitoring:
ispstop
18-8
ispstatus
ispstatus
Name
ispstatus
Display performance monitoring status
Synopsis
ispstatus [-M system-name]
Description
This command displays performance monitoring status.
The argument of the ispstatus command is explained below.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Display Information
The format in which the performance monitoring status is output is explained below.
•
Amount of shared memory (shm)
Indicates the amount of shared memory that is used to acquire the performance information. Unit of
display is Mega bytes.
•
Time of interval (time)
The time of interval to save the performance information in the performance log file. Unit of display
is "hour" and "minute". Unit is displayed as follows.
−
Hour:hour(s)
−
Minute:minute(s)
•
Name of folder that creates the performance log file(dir)
The name of folder that creates the performance log file. It is displayed with the absolute path.
•
Performance monitoring status (status)
It is under the performance monitoring status.
−
active:Under monitoring
−
inactiveUnder stopping
•
Performance monitoring tool operating mode (mode)
(Enterprise Edition and Standard Edition only)
Displays the operating status of the performance monitoring tool.
18-9
Chapter 18: Performance Analysis Monitoring Commands
−
−
manual : Manual operation
auto : Automatic operation
•
Name of the object that is the target of measurement (obj)
List of names of objects that are the target of measurement.
•
EJB application names to be measured (ejp-apl)
List of EJB application names to be measured
•
Light EJB container names to be measured (ejp-cont)
List of Light EJB container names to be measured
•
Implementation Repository ID to be measured (impl-ID)
List of Implementation Repository ID to be measured
For Plus, only the EJB application name and Light EJB container name are displayed.
Notes
•
Only system administrators are authorized to execute this command.
•
If the performance monitoring environment has not been created, an error message will appear,
and the performance monitoring status will not be displayed.
Examples
The following example shows the performance monitoring status in a case where performance
monitoring with one hour intervals was started with 1MB of shared memory and
c:\INTERSTAGE\td\isp\log was specified as the folder name.
ispstatus
shm
: 1
time
: 1 hour(s)
dir
: c:\INTERSTAGE\td\isp\log
status : active
obj
: object001
: object002
ejb-apl:ejbapl1
ejb-cont:ejbcont1
impl-ID:IDL:FJ/ImplementationRep:1.0
The following example shows the performance monitoring status in a case where shared memory of
2MB and a folder name of c:\INTERSTAGE\td\isp\log were specified for performance monitoring with
five-minute intervals and performance monitoring was stopped.
ispstatus
shm
:
time
:
dir
:
status :
18-10
2
5 minute(s)
c:\INTERSTAGE\td\isp\log
inactive
ispstatus
The following example shows the performance monitoring status in a case where performance
monitoring with one hour intervals was started with 1MB of shared memory and /opt/FSUNtd/isp/log was
specified as the folder name.
ispstatus
shm
: 1
time
: 1 hour(s)
dir
: /opt/FSUNtd/isp/log
status : active
obj
: object001
: object002
ejb-apl:ejbapl1
ejb-cont:ejbcont1
impl-ID:IDL:FJ/ImplemetationRep:1.0
The following example shows the performance monitoring status in a case where shared memory of
2MB and a folder name of /opt/FSUNtd/isp/log were specified for performance monitoring with fiveminute intervals and performance monitoring was stopped.
ispstatus
shm
:
time
:
dir
:
status :
2
5 minute(s)
/opt/FSUNtd/isp/log
inactive
The following example shows the performance monitoring status in a case where performance
monitoring with one hour intervals was started with 1MB of shared memory and /opt/FJSVtd/isp/log was
specified as the folder name.
ispstatus
shm
: 1
time
: 1 hour(s)
dir
: /opt/FJSVtd/isp/log
status : active
obj
: object001
: object002
ejb-apl:ejbapl1
ejb-cont:ejbcont1
impl-ID:IDL:FJ/ImplemetationRep:1.0
The following example shows the performance monitoring status in a case where shared memory of
2MB and a folder name of /opt/FJSVtd/isp/log were specified for performance monitoring with fiveminute intervals and performance monitoring was stopped.
ispstatus
shm
:
time
:
dir
:
status :
2
5 minute(s)
/opt/FJSVtd/isp/log
inactive
18-11
Chapter 18: Performance Analysis Monitoring Commands
ispreport
Name
ispreport
Report output.
Synopsis
ispreport [-b begin_time] [-e end_time] [-k kind] file_name
Description
This command reads performance information, one record at a time, from the performance log files
where performance information is stored as binary data. This command converts the data to text format
(CSV format), then sends it to the standard output.
The ispreport options and arguments are explained below:
When the -k option is omitted, output the performance information on transaction application and a
wrapper. The information about the wrapper is output only in the Windows(R) and Solaris OE editions.
-b begin_time
This specifies the start time for report output. Performance information stored after the specified time is
extracted from the specified performance log file to output the report. If the start time is not specified,
performance information starting from the start of the specified file is output in the report.
Times are specified as follows:
Format:
YYYY:
MM:
DD:
hh:
mm:
{YYYY}MMDDhhmm
Western year (4 digits)
Month (01 to 12)
Day (01 to 31)
Hour (00 to 23)
Minutes (00 to 59)
-e end_time
This specifies the end time for report output. Performance information stored before the specified time
is extracted from the specified performance log file to output the report. If the end time is not specified,
performance information up to the end of the specified file is output in the report.
The time specification method is the same as the -b option.
18-12
ispreport
-k kind
This specifies the performance information for which surveillance is displayed. The following can be
specified to be kind.
kind specification
character sequence
Operation
TDOBJ
The report of the performance information on the object of transaction
application is output. The information on wrapper is output only in the
Windows(R) and Solaris OE editions.
EJBAPL
The report of the performance information on the EJB application or Light
EJB container is output.
IMPLID
The report of the performance information on implementation repository of
CORBA application is output.
For Plus, only EJBAPL can be specified.
file_name
This specifies the absolute pathname of the performance log file where the performance information is
stored. Use spaces as delimiters to specify multiple file names.
Specify the file names of performance log files as shown below:
“folder name\file name”
Folder name:
The folder specified when the ispmakeenv command was executed, or the folder specified in the
ISP_LOG environment variable
File name:
isp YYYYMMDD.log
where, YYYYMMDD is the file creation date.
YYYY:
Western year
MM:
Month (01 to 12)
DD:
Day (01 to 31)
“/directory name/file name”
directory name:
The directory specified when the ispmakeenv command was executed, or the directory specified in the
ISP_LOG environment variable.
File name:
isp YYYYMMDD.log
where, YYYYMMDD is the file creation date.
YYYY:
Western year
18-13
Chapter 18: Performance Analysis Monitoring Commands
MM:
Month (01 to 12)
DD:
Day (01 to 31)
Report Output Format
The report output format is explained below.
The performance information records are converted to text format one record at a time, and each record
is displayed in a separate row of the report. Each line displays up to 22 information items depending on
the application type. Those items are separated by a comma (,) as follows:
“D1, D2, D3, D4, D5, D6, D7, D8, D9, D10, D11, D12, D13, D14, D15, D16, D17, D18, D19, D20, D21,
D22”
The items displayed in each row are:
For transaction application or wrapper
The information about the wrapper is output only in the Enterprise Edition and Standard Edition of
Windows(R) and Solaris OE editions.
The information about the transaction application is output only in the Enterprise Edition and Standard
Edition.
D1: Data collection start date
D2: Data collection start time
D3: Data collection end date
D4: Data collection end time
D5: Object name
D6: Operation name
D7: Process number
D8: Maximum request processing time (milliseconds)
D9: Minimum request processing time (milliseconds)
D10: Average request processing time (milliseconds)
D11: Maximum request processing wait time (milliseconds)
D12: Minimum request processing wait time (milliseconds)
D13: Average request processing wait time (milliseconds)
D14: Number of processes
D15: Number or requests received
D16: Number of requests waiting for processing.
For EJB application
D1: Data collection start date
D2: Data collection start time
D3: Data collection end date
D4: Data collection end time
D5: EJB application name
18-14
ispreport
D6: Method name + Signature
D7: Process ID
D8: Thread ID
D9: Maximum request processing time (milliseconds)
D10: Minimum request processing time (milliseconds)
D11: Average request processing time (milliseconds)
D12: Maximum request processing wait time (milliseconds)
D13: Minimum request processing wait time (milliseconds)
D14: Average request processing wait time (milliseconds)
D15: Number of processes
D16: Number or requests received
D17: Number of requests waiting for processing
D18: Number of EJB objects (Session)
D19: Maximum number of Passivate items for entity
D20: Maximum size of memory area used in VM
D21: Average size of memory area used in VM.
For Light EJB container
D1: Data collection start date
D2: Data collection start time
D3: Data collection end date
D4: Data collection end time
D5: Light EJB container name/EJB application name
D6: Method name + Signature
D7: Process ID
D8: Thread ID
D9: Maximum request processing time (milliseconds)
D10: Minimum request processing time (milliseconds)
D11: Average request processing time (milliseconds)
D12: Maximum request processing wait time (milliseconds)
D13: Minimum request processing wait time (milliseconds)
D14: Average request processing wait time (milliseconds)
D15: Number of processes
D16: Number or requests received
D17: Number of requests waiting for processing
D18: Number of EJB objects (Session)
18-15
Chapter 18: Performance Analysis Monitoring Commands
D19: Maximum number of Passivate items for entity
D20: Maximum size of memory area used in VM
D21: Average size of memory area used in VM.
For CORBA application
The items below are output only in the Enterprise Edition and Standard Edition.
D1: Data collection start date
D2: Data collection start time
D3: Data collection end date
D4: Data collection end time
D5: Implementation Repository ID
D6: Object name
D7: Operation name
D8: Process ID
D9: Thread ID
D10: Maximum request processing time (milliseconds)
D11: Minimum request processing time (milliseconds)
D12: Average request processing time (milliseconds)
D13: Maximum request processing wait time (milliseconds)
D14: Minimum request processing wait time (milliseconds)
D15: Average request processing wait time (milliseconds)
D16: Maximum data length (byte)
D17: Minimum data length (byte)
D18: Average data length (byte)
D19: Number of processes
D20: Number or requests received
D21: Number of requests waiting for processing.
Notes
18-16
•
Only system administrators are authorized to execute this command.
•
If the performance log files do not contain any performance information, reports are not output.
ispreport
Examples
•
Output a report based on the performance information stored in the performance log file
c:\INTERSTAGE\td\isp\log\isp19981026.log.
ispreport c:\INTERSTAGE\td\isp\log\isp19981026.log.
19981026, 0900, 19981026, 1000, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 0900, 19981026, 1000, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 0900, 19981026, 1000, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
…
•
Output a report based on the performance information stored in the performance log file
c:\INTERSTAGE\td\isp\log\isp19981026.log, starting from 26/10/98 at 13:00 hours and ending at
26/10/98 at 15:00 hours.
ispreport –b 199810261300 –e 199810261500
c:\INTERSTAGE\td\isp\log\isp19981026.log.
19981026, 1300, 19981026, 1400, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 1300, 19981026, 1400, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 1300, 19981026, 1400, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
...
•
Output a report based on the performance information stored in the performance log file
/opt/FSUNtd/isp/log/isp19981026.log.
ispreport /opt/FSUNtd/isp/log/isp19981026.log.
19981026, 0900, 19981026, 1000, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 0900, 19981026, 1000, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 0900, 19981026, 1000, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
...
18-17
Chapter 18: Performance Analysis Monitoring Commands
•
Output a report based on the performance information stored in the performance log file
/opt/FSUNtd/isp/log/isp19981026.log, starting from 26/10/98 at 13:00 hours and ending at 26/10/98
at 15:00 hours.
ispreport –b 199810261300 –e 199810261500
/opt/FSUNtd/isp/log/isp19981026.log.
19981026, 1300, 19981026, 1400, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 1300, 19981026, 1400, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 1300, 19981026, 1400, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
...
•
Output a report based on the performance information stored in the performance log file
/opt/FJSVtd/isp/log/isp19981026.log.
ispreport /opt/FJSVtd/isp/log/isp19981026.log.
19981026, 0900, 19981026, 1000, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 0900, 19981026, 1000, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 0900, 19981026, 1000, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
...
•
Output a report based on the performance information stored in the performance log file
/opt/FJSVtd/isp/log/isp19981026.log, starting from 26/10/98 at 13:00 hours and ending at 26/10/98
at 15:00 hours.
ispreport –b 199810261300 –e 199810261500
/opt/FJSVtd/isp/log/isp19981026.log.
19981026, 1300, 19981026, 1400, obj01, ope01, 13, 150, 100, 120, 400, 300,
360, 121, 28, 19
19981026, 1300, 19981026, 1400, obj02, ope02, 18, 150, 100, 120, 400, 300,
360, 104, 28, 19
19981026, 1300, 19981026, 1400, obj03, ope03, 26, 150, 100, 120, 400, 300,
360, 89, 28, 19
...
18-18
ispsetagt
ispsetagt
Name
ispsetagt
Registers the performance monitoring tools as SNMP service subagents.
Synopsis
ispsetagt InterstageFolder
Description
This command registers performance monitoring tools as subagents of the SNMP service.
The arguments of the ispsetagt command are explained below.
InterstageFolder
Specify the absolute path for the Interstage install folder.
This option is mandatory. If omitted, registration of the performance monitoring tools fails.
Notes
•
Only system administrators are authorized to execute this command.
•
Install the SNMP service before executing this command. If the service has not been installed,
registration of the performance monitoring tools fails.
•
After this command is executed, restart the SNMP service.
Example
Register the performance monitoring tools as SNMP service subagents. The Interstage install folder is
c:\INTERSTAGE.
ispsetagt c:\INTERSTAGE
18-19
Chapter 18: Performance Analysis Monitoring Commands
ispunsetagt
Name
ispunsetagt
Deletes the performance monitoring tools from the SNMP service.
Synopsis
ispunsetagt
Description
This command deletes the performance monitoring tools from the SNMP service.
Notes
•
Only system administrators are authorized to execute this command.
•
After this command is executed, restart the SNMP service.
Example
Delete the performance monitoring tools from the SNMP service.
Ispunsetagt
18-20
ispsetautostart
ispsetautostart
Name
ispsetautostart
Registers the automatic start definition for the performance monitoring tool.
Synopsis
ispsetautostart file_name
Description
The ispsetautostart command registers the automatic start definition for performance monitoring tool.
The performance monitoring tool is started by starting Interstage after this command is executed.
The arguments of the ispsetautostart command are explained below:
file_name
Specifies the name of a performance monitoring tool automatic start definition file with a full path. This
option is mandatory; therefore, it cannot be omitted.
For details about the performance monitoring tool automatic start definition, refer to the Performance
monitoring tool automatic start definition file (ispsetautostart command) in the Interstage Operations
Guide.
Notes
•
Only system administrators are authorized to execute this command.
•
The performance monitoring tool is automatically started at activation of Interstage by executing
this command. When manually operating the performance monitoring tool, do not execute this
command.
•
This command cannot be executed during activation of the performance monitoring tool.
•
After this command is executed, the performance monitoring tool cannot be started or stopped with
the ispmakeenv or ispdeleteenv command. The performance monitoring tool can be started and
stopped only by activating or terminating Interstage.
Example
ispsetautostart c:\temp\ispauto.txt
18-21
Chapter 18: Performance Analysis Monitoring Commands
ispunsetautostart
Name
ispunsetautostart
Deletes the automatic start definition for the performance monitoring tool.
Synopsis
ispunsetautostart
Description
The ispunsetautostart command deletes the automatic start definition for the performance monitoring
tool.
Notes
•
Only system administrators are authorized to execute this command.
•
This command cannot be executed during activation of the performance monitoring tool.
Example
ispunsetautostart
18-22
ispinfautodef
ispinfautodef
Name
ispinfautodef
Displays the contents of the automatic start definition for a performance monitoring tool.
Synopsis
ispinfautodef
Description
The ispinfautodef command outputs the contents of the registered automatic start definition for the
performance monitoring tool to the standard error output file.
Notes
•
Only system administrators are authorized to execute this command.
Example
ispinfautodef
[Control]
Shmsize = 10
Auto_Start = yes
Log_Path = c:\temp
[Interval]
local_interval = 30m
real_interval = 5
[TD-OBJECT]
TYPLNG/INTF
[EJB-APPLICATION]
ejbful
[CORBA-IMPLID]
IDL:ODsample/stringtest:1.0
IDL:ODsample/anytest:1.0
[EJBCONT]
Server0001
18-23
Chapter 18: Performance Analysis Monitoring Commands
18-24
Chapter 19
Directory Service Linkage Setup
Commands
This chapter details the Directory Service Linkage Setup Commands.
Note
The directory service linkage setup command is available for the following products of the Windows®
system and Solaris OE system:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
19-1
Chapter 19: Directory Service Linkage Setup Commands
tdresetaso
Name
tdresetaso
Re-synchronize Component Transaction Service security function with InfoDirectory.
Synopsis
tdresetaso
Description
The tdresetaso command is executed to synchronize information between InfoDirectory and Interstage
when the InfoDirectory entry used has been updated, on the server using the Component Transaction
Service access control.
Notes
19-2
•
Only system administrators are authorized to execute this command.
•
Execute this command after setting the identifier for the administrator and the password for the
target entries of InfoDirectory using the tdsetauthmanager command.
•
This command cannot be used in the extended system with the multi system function.
tdsetauthmanager
tdsetauthmanager
Name
tdsetauthmanager
Set identification name and password for InfoDirectory entry manager to be used in Component
Transaction Service access control.
Synopsis
tdsetauthmanager -u userDN -p password
Description
If the Component Transaction Service uses access control and authentication objects that use user
names are used, execute the tdsetauthmanager command to set the Administrator's identifier name and
password for entries targeted by InfoDirectory.
This command can be executed only once, when the system is built.
However, if the Administrator is changed at InfoDirectory, this command must be executed again to
reset the Administrator. If this command is entered while Interstage is running, after the command is
executed, the settings made by this command can be used from the access control for currently running
WorkUnits and from the authentication process based on authentication objects that use user names.
The options and arguments of the tdsetauthmanager command are explained below.
-u userDN
Specify the identification name of the InfoDirectory manager. Give the identification name of the
manager who can access the InfoDirectory entries.
This option may not be omitted.
The value specified must not be more than 255 bytes.
Space characters must not be specified.
-p password
Specify the password of the InfoDirectory manager. Give the value specified in the userPassword
attribute of the entries specified in the manager’s identification name.
This option may not be omitted.
The value specified must not be more than 128 bytes.
Use only ASCII code characters in the password.
Space characters must not be specified.
19-3
Chapter 19: Directory Service Linkage Setup Commands
Notes
19-4
•
Only system administrators are authorized to execute this command.
•
The “entries subject to access control” means the entries for which access permissions affecting
access to entries subject to access control registered with InfoDirectory, have been set up in
InfoDirectory. It is not necessary to have access permissions for all the entries in InfoDirectory.
•
EJB WorkUnits are excluded from security of the Component Transaction Service.
•
This command cannot be used in the extended system with the multi system function.
Part 6
Cluster Service Operation Edition
Chapter 20
Cluster Service Operation Commands
This chapter details the Cluster Service commands.
Note
The cluster service operation command is available for the following products:
•
Interstage Application Server Enterprise Edition.
20-1
Chapter 20: Cluster Service Operation Commands
isgetstatus
Name
isgetstatus
Checks the operation status of Interstage.
Synopsis
isgetstatus [-M system-name]
Description
This command checks the operation status of Interstage.
The operation status of Interstage is reported with the end code of the command.
The option and end code for this command and its meaning are as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
End code of command
100 : Started
101 : Not started
102 : Being started
103 : Being stopped
104 : Being prestarted
1 : Parameter error
2 : Other errors (A message indicating the error cause is output to the event log).
Notes
•
Only the superuser is authorized to execute this command.
•
Use this command only in cluster systems.
Example
isgetstatus
20-2
isstandby
isstandby
Name
isstandby
Prestarts up Interstage.
Synopsis
isstandby [-M system-name]
Description
This command prestarts Interstage at a standby node when the system includes a cluster system of
standby operation.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only the superuser is authorized to execute this command.
•
Use this command to prestart the system at a standby node only when the system includes a
standby operation of cluster system.
Example
isstandby
20-3
Chapter 20: Cluster Service Operation Commands
isstandbywu
Name
isstandbywu
Prestarts up WorkUnit.
Synopsis
isstandbywu [-M system-name] wuname
Description
This command pre-starts a WorkUnit in a standby node when the cluster service is used.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the name of a WorkUnit to be pre-started. The type of the WorkUnit to be specified must be
ORB, WRAPPER, or EJB.
Notes
•
Specify this command only when the cluster service is used.
•
A WorkUnit started with the isstandbywu command operates using a qualification of the user who
entered the command. The user who enters the command must have the authorizations indicated
below for resources accessed by applications on the WorkUnit:
−
−
−
•
Read permission and write permission for disk partition in business system area
Authorizations for a file system required to use a directory and file specified in the WorkUnit
definition
Permission for using resources used by an application on the WorkUnit.
When memory is insufficient, the tdstandbywu command may return no response.
Example
isstandbywu TDSAMPLE1
20-4
isrelease
isrelease
Name
isrelease
Activates the prestarted Interstage.
Synopsis
isrelease [-M system-name]
Description
This command enables Interstage that is activated beforehand in the standby node when a switch event
occurs in the operation standby type cluster system.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only the superuser is authorized to execute this command.
•
This command must be used only for prior-start operation in the standby node of the cluster system.
Example
isrelease
20-5
Chapter 20: Cluster Service Operation Commands
isreleasewu
Name
isreleasewu
Activates the prestarted WorkUnit.
Synopsis
isreleasewu [-M system-name] wuname
Description
This command activates a WorkUnit pre-started in a standby node at switching for a cluster service.
The argument for this command is as follows:
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specifies the name of a WorkUnit to be activated. The type of the WorkUnit to be specified must be
ORB, WRAPPER, or EJB.
Notes
•
Specify this command only when the cluster service is used.
•
Only the user who pre-started a WorkUnit can activate the WorkUnit.
Example
isreleasewu TDSAMPLE1
20-6
odinspect
odinspect
Name
odinspect
Monitors the CORBA Service.
Synopsis
odinspect [-t second] {[od] [ns] [lbo] [ir] [ire]} [-M system]
Description
The odinspect command monitors a specified service for a specified period, and terminates if the
service stops or cannot be used due to an error or similar reason.
It is possible to verify that a service has stopped or generated an error by means of the system log. If
more than one service stops or generates an error, only the service detected first is output to the system
log.
The parameters that can be specified are explained below.
-t second
Specify the time to monitor the service (1 to 99999 seconds). If omitted, the period is assumed to be 60
(seconds).
od
Monitors the CORBA Service (Implementation Repository Service).
ns
Monitors the Naming Service.
lbo
Monitors the Load Balancing function.
ir
Monitors the Interface Repository Service (for standard interface).
ire
Monitors the Interface Repository Service (for value interface).
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
20-7
Chapter 20: Cluster Service Operation Commands
Note
This command is used in the mutual standby type state transition procedure of the Cluster Service
function (SynfinityCLUSTER).
SynfinityCLUSTER detects the termination of this command and performs node switching.
20-8
tdrelease
tdrelease
Name
tdrelease
Activation of the previously started Component Transaction Service (TD).
Synopsis
tdrelease [-M ystem-name]
Description
The tdrelease command activates the Component Transaction Service previously started in the standby node when node switching has occurred in the 1:1 operating stand-by mode of the
SynfinityCLUSTER.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only superusers are authorized to execute this command.
•
Use this command only in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
Example
TD_HOME=/opt/FSUNtd
export TD_HOME
tdrelease
20-9
Chapter 20: Cluster Service Operation Commands
tdreleasewu
Name
tdreleasewu
Activation of WorkUnit of the previously started Component Transaction Service.
Synopsis
tdreleasewu [-M system-name] wuname
Description
The tdreleasewu command activates the WorkUnit of the Component Transaction Service previously
started in the stand-by node when switching has occurred in the 1:1 operating stand-by mode of the
SynfinityCLUSTER.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the WorkUnit name to be activated.
Notes
•
Use this command only in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
•
This command can be started only in a WorkUnit whose WorkUnit type is "ORB" or "WRAPPER."
Example
tdreleasewu TDSAMPLE1
20-10
tdstandby
tdstandby
Name
tdstandby
Previous activation of the Component Transaction Service (TD).
Synopsis
tdstandby [-M system-name]
Description
The tdstandby command activates previously the Component Transaction Service in the stand-by node
in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
Notes
•
Only superusers are authorized to execute this command.
•
Use this command only in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
•
Before previously activating the Component Transaction Service, home directory of the Component
Transaction Service must be set in the environment variable TD_HOME.
Example
TD_HOME=/opt/FSUNtd
export TD_HOME
tdstandby
20-11
Chapter 20: Cluster Service Operation Commands
tdstandbywu
Name
tdstandbywu
Previous activation of WorkUnit of the Component Transaction Service.
Synopsis
tdstandbywu [-M system-name] wuname
Description
The tdstandbywu command activates previously the WorkUnit of the Component Transaction Service in
the stand-by node in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
-M system-name
Specify the name of the target system.
If this option is omitted, the default system is assumed to be specified.
wuname
Specify the WorkUnit name to be activated previously.
Notes
•
Use this command only in the 1:1 operating stand-by mode of the SynfinityCLUSTER.
•
The WorkUnit activated by the tdstandbywu command operates with the qualification of the
command executor. Therefore, the command executor must have the following permissions to the
resources to which the application on the WorkUnit accesses.
−
−
−
Permission to read and write to the disk partition for business system section.
Permission to the file system to use the directory and the file specified by the WorkUnit
definition.
Permission to the resources to which the application on the WorkUnit accesses.
•
The tdstandbywu command may not get any response if memory shortage occurred.
•
This command can be started only in a WorkUnit whose WorkUnit type is "ORB" or "WRAPPER."
Example
tdstandbywu TDSAMPLE1
20-12
Part 7
Development Edition
Chapter 21
Application Development Commands
This chapter explains the Application Development commands.
Note
The Application development command can be used in the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
In the Standard Edition, only the following commands can be used:
−
−
•
IDLc
tdc
Interstage Application Server Plus
In the Plus Edition, only the following commands can be used:
−
IDLc
21-1
Chapter 21: Application Development Commands
IDLc
Name
IDLc
IDL Compiler.
Synopsis
IDLc [-C]|-ccp|-cobol|-oocob|-java|-vcpp|-soap [-mss[SS]] [-MSV] [-MCL]
[-a [-create|-update|-delete] |-R [-create|-update|-delete]][-tie]
[-lc] [-ls] [-noex] [-tie] [-Idir] [-Dname] [-noinclude] [-dy] [-oprefix]
[-Sname] [-Tdir] [-mapinfo] [-f] [-nolog] [-M system] [IDLfile]
Description
This command creates stubs and skeletons mapped in the specified language (C, C++, Java, COBOL,
OOCOBOL, or Visual C++) from an IDL file specified by IDLfile. The default of IDLfile is foo.idl. The file
name must be "XX.idl" (XX is an arbitrary character string, and the extension "idl" must be specified
using lower-case letters).
The IDLc command generates a CORBA/SOAP gateway file that is mapped to the Java language from
the IDL file specified with the IDLfile parameter.
The options of this command are as follows. If two exclusive options are specified, only the last option is
valid.
Mapping Language Options
The following language mapping options can be specified. The default is -C.
-C
Stub and skeleton files are created in C.
-cpp
Stub and skeleton files are created in C++.
-cobol
Stub and skeleton files are created in COBOL.
-oocob
Stub and skeleton files are created in OOCOBOL (Object Oriented COBOL).
-java
Stub and skeleton files are created in Java.
21-2
IDLc
-vcpp
Stub and skeleton files are created for Visual C++.
If different language mapping is required for stub and skeleton files, the following options can be
specified:
-soap
Generate a CORBA/SOAP gateway file. This option can generate only a CORBA/SOAP server gateway
file by specifying together with the -MSV option and only a CORBA/SOAP client gateway file by
specifying together with the -MCL option. If none of -MSV and -MCL is specified or both of them are
specified, both a CORBA/SOAP server gateway file and a CORBA/SOAP client gateway file are
generated.
-mss[SS]
Skeleton files are created in a different development language from that used for stub files. “c” (C), “cpp”
(C++), “cobol” (COBOL), “oocob” (OOCOBOL), or java (Java) can be specified as the language
mapping for skeleton files in SS.
The language mapping for stub files follows the same specification as those listed above: (-C, -cpp, cobol, -oocob, -java, and -vcpp). When “SS” is specified, the suffix of the skeleton filename can be
changed. When “SS” is not specified, “SS=c” is assumed for “- mc”, or “SS=cpp” is assumed for “-mcpp”.
For “-mcobol” , “-moocob” or -mjava, “SS” is ignored.
Note that when the Linux system is a server machine, the skeleton and other files created by –
mcobol and –moocob cannot be used.
Names of files created
Tables 21-1 to 21-6 list the names of the stub and skeleton files created (“xx.idl” indicates an IDL
filename. MM a module, and “yy” and “zz” indicate the interface and data type name defined in the IDL
file, respectively.)
Programming language C
Table 21-1 Created Stub and Skeleton Files (C)
File type
-m specified
-m not specified
Stub and skeleton
Stub
Skeleton
xx.h
xx.h
xx_cdr.h
Common header file
xx_cdr.h
xx_cdr.h
xx_cdr_SS.h
CDR header file
xx_cdr.c
xx_cdr.c
xx_cdr_SS.c
CDR source file
xx_stub.c
xx_stub.c
Stub file
xx_skel.c
xx_skel.c
Skeleton file
yy_skel.c
yy_skel.c
Skeleton file (when -dy is specified)
21-3
Chapter 21: Application Development Commands
Programming language C++
Table 21-2 Created Stub and Skeleton Files (C++)
File type
-m specified
-m not specified
Stub and skeleton
Stub
Skeleton
xx.H
xx.H
xx.H
Common header file
xx_SS.h
Common header file
xx.h
xx_cdr.h
xx_cdr.h
xx_cdr_SS.h
CDR header file
xx_cdr.c
xx_cdr.c
xx_cdr_SS.c
CDR source file
xx_c++.C
xx_c++.C
xx_c++.C
Class method
xx_stub_c++.C
xx_stub_c++.C
Stub file
xx_skel_c++.C
xx_skel_c++.C
Skeleton file
yy_skel_c++.C
yy_skel_c++.C
Skeleton file(when -dy is specified)
Programming language COBOL
Table 21-3 Created Stub and Skeleton Files (COBOL)
File type
-m specified
-m not specified
Stub and skeleton
Stub
Skeleton
xx_cdr.cbl
xx_cdr.cbl
xx_cdr.cbl
xx_stub.cbl
xx_stub.cbl
CDR source file
Stub file
xx_yy_skel.cbl
xx_yy_skel.cbl
Skeleton file
xx_skel.cbl
xx_skel.cbl
Skeleton for area allocation (See
Note 1)
xx_h.cbl
Data type definition file (See Note
2)
xx_h.cbl
xx_h.cbl
Programming language OOCOBOL (See Note 3)
Table 21-4 Created Stub and Skeleton Files (OOCOBOL)
21-4
-m specified
-m not specified
File type
Stub and skeleton
Stub
Skeleton
xx--REP.cbl
xx--REP.cbl
xx--REP.cbl
Repository level declaration registry
xx--CONST.cbl
xx--CONST.cbl
xx--CONST.cbl
Constant declaration registry
xx--COPY.cbl
xx--COPY.cbl
xx--COPY.cbl
TYPEDEF type declaration registry
yy.cob
yy.cob
yy.cob
Interface file
yy--helper.cob
yy--helper.cob
yy--helper.cob
Helper class file
yy--stub.cob
yy--stub.cob
Stub class file
yy--NarrowStub.cob
yy--NarrowStub.cob
Narrow stub file
IDLc
-m specified
-m not specified
Stub and skeleton
Stub
File type
Skeleton
yy--NarrowSkel.cob
yy--NarrowSkel.cob
Narrow skeleton file
yy--tie.cob
yy--tie.cob
Tie class file
yy--NEW.cob
yy--NEW.cob
Implementation registration file
zz.cob
zz.cob
zz.cob
Data type class file (See Note 4)
zz--helper.cob
zz--helper.cob
zz--helper.cob
Data type helper file (See Note 4)
Programming language Java (See Note 5)
Table 21-5 Created Stub and Skeleton Files (Java)
-m specified
-m not specified
Stub and
skeleton
Skeleton
File type
Stub
MM/yy.java
MM/yy.java
Interface class file
MM/yyOperations.java
MM/yyOperations.java
Interface operations file
MM/yyHelper.java
MM/yyHelper.java
Helper class file
MM/yyHolder.java
MM/yyHolder.java
Holder class file
MM/_yyStub.java
MM/_yyStub.java
Stub class file
MM/yyPOA.java
-
Skeleton class file
MM/yyPOATie.java
-
tie class file
MM/yyPackage/zz.java
MM/yyPackage/zz.java
Data type class file
MM/yyPackage/zzHelper.java
MM/yyPackage/zzHelper.java
Data type Helper file
MM/yyPackage/zzHolder.java
MM/yyPackage/zzHolder.java
Data type Holder file
Programming language Visual C++
Table 21-6 Created Stub and Skeleton Files (VC++)
File type
-m specified
-m not specified
Stub and skeleton
Stub
xx.h
xx.h
Common header file
xx_cdr.h
xx_cdr.h
CDR header file
xx_cdr.cpp
xx_cdr.cpp
CDR source file
xx_c++.cpp
xx_c++.cpp
Class method definition file
xx_stub.cpp
xx_stub.cpp
Stub file
Skeleton
xx_skel.cpp
Skeleton file
yy_skel.cpp
Skeleton file (when -dy is specified)
21-5
Chapter 21: Application Development Commands
Notes
1.
The area allocation functions for the IDL definitions that are not a basic data type are incorporated
into this skeleton. If the IDL definitions are a basic data type, this skeleton is not created.
2.
This file defines the data types to be used for stubs and skeletons, and must be referenced when
creating applications.
3.
Full scope names used for ‘yy’ (interface name) and ‘zz’ (data type name).
4.
Generates files for the following declarations: typedef, string (with size specified), wstring (with size
specified), enum, sequence, struct, union, fixed,and exception
5
Mapping with the Java language maps files by creating a directory structure (Java packages) that
corresponds to the IDL structure.
If separate data definitions are included in the data definitions (zz), further sub directories are
generated for the zzPackage name, and the class files related to these new data definitions are
stored under the sub directories.
SOAP Options
-MSV
Generate a CORBA/SOAP server gateway file. This option needs to be specified together with the soap option.
-MCL
Generate a CORBA/SOAP client gateway file. This option needs to be specified together with the -soap
option.
Files Generated when SOAP Option is Specified
When the -soap option is specified in this command, the files listed below are generated as
CORBA/SOAP getaway files in addition to the files that are output in Java language. These files are
stored in the directory (Java package) that corresponds to the IDL structure. The <module name> in
Table 21-7 is the same as the module name defined in the IDL file.
When there is another data definition in the data definition (zz), a subdirectory named "zzPackage" is
generated and a new class file about the data definition is stored in the subdirectory.
Table 21-7 Files Generated with SOAP Option
When -MSV or -MCL
is not specified
When -MSV is
specified
When -MCL is
specified
MM/_yySOAPGWstub.java
MM/_yySOAPGW
Servant.java
21-6
File type
CORBA/SOAP server gateway file
MM/_yySOAPGW
Servant.java
CORBA/SOAP client gateway
servant file
MM/_yySOAPGW_dd.xml
SOAP deploy information file
MM/yyPackage/zzSOAPGWType.java
SOAP data-type class file
MM/yyPackage/zzSOAPEnumImpl.java
SOAP Enum-type class file
IDLc
Operation Mode Options
Use the -a option to create stubs and skeletons and to register interface information in the Interface
Repository. Use the -R option to register interface information in the Interface Repository without
creating stubs and skeletons. Either option can be specified.
If neither of the two options are specified, this command creates stubs and skeletons only. Interface
information is not registered in the Interface Repository.
-a
This option specifies that the command creates stubs and skeletons, and registers interface information
in the Interface Repository. This option must be specified with the - create, -update, or -delete options.
-R
This option specifies that the command only registers interface information in the Interface Repository,
without creating stubs and skeletons. This option must be specified with the -create, -update, or delete options.
Interface Repository Registration Options
The -create, -update, or -delete options can be specified. If omitted, the -create option is assumed.
Specify one of the above operation mode options with one of the following Interface Repository
registration options:
-create
This option specifies that interface information is to be registered in the Interface Repository. If the same
identifier has already been registered, an error occurs and current processing is invalidated.
-update
This option specifies that interface information is to be registered in the Interface Repository. If the same
identifier has already been registered, the relevant interface information is updated. Specify this option
when the relevant IDL file has been changed.
-delete
This option specifies that interface information is to be deleted from the Interface Repository. If the
specified identifier has not been registered, an error occurs.
To modify IDL files, or modify or delete IDL definition information previously registered in the Interface
Repository, use the unmodified IDL files (registered in the Interface Repository) and delete the
information registered with the –delete option. Then re-register the modified IDL files.
Stub and skeleton creation mode options
-lc
-ls
These options are used to link the stubs and skeletons created by the IDLc command, to form a module.
The XX_alloc function (the area allocation function for non basic data types) is usually invoked in both
the created stub and skeleton. This option is used when the function is invoked in the stub or skeleton
only, or in neither. Refer to the explanation of the mapping for each data type in the Distributed
Application Development Guide (CORBA Service Edition). This is provided with Enterprise Edition and
Standard Edition products for details.
To link stub and skeleton, specifying “-D_MULTI_LINK_” invoking C++ compiler when mapping language
is C++ (-cpp), or specifying “_MULTI_LINK_” macro using Visual C++ (-vcpp).
21-7
Chapter 21: Application Development Commands
-ls
Creates the function in the skeleton only.
-lc
Creates the function in the stub only.
-ls -lc
Creates the function in neither the stub nor the skeleton.
This option is valid when the language mapping is for the C language (-C or -mc is specified), or
COBOL (-cobol or -mcobol is specified).
When the mapping language is C++ (-cpp), "-D_MULTI_LINK_" can be specified when the C++ compiler
is executed to link the stub and skeleton.
When the mapping language is Visual C++ (-vcpp), the "_MULTI_LINK_" macro can be specified when
the C++ compiler is executed to link the stub and skeleton. (If so, the skeleton area allocation function
becomes invalid.)
-noex
This option specifies that exception processing is invoked by the CORBA::Environment method. If this
option is omitted, exception processing is invoked by the try catch method. This option is valid when the
language mapping is for the C++ language (-cpp or -mcpp is specified).
-tie
Generates files in TIE class. If this option is omitted, files are generated in impl class. This option is
effective when the mapping language is C++ (-cpp, mcpp) or Visual C++ (-vcpp). For further details,
refer to information about the Interface Installation Function in the Distributed Application Development
Guide (CORBA Service Edition). This is provided with Enterprise Edition and Standard Edition products.
Other Options
-Idir
This option specifies that the file specified by an #include statement is searched for, and the directory
specified by “dir” is added in the directories. This can be specified more than once.
The directories are searched in the order of specification.
-Dname[=val]
This option defines a macro name. Specifying this option is the same as specifying “#define name val”
at the beginning of the IDL file. If “=val” is omitted from “-Dname[=val]”, it is equivalent to specifying
“#define name.”
-noinclude
This option specifies that the file specified in an #include statement is not mapped. This option cannot
be specified with the -create or -delete options. To delete interface information from the Interface
Repository, invoke the IDLc command with “-R -delete” once.
This option is valid when the language mapping is for the C, C++, COBOL, or Visual C++ languages.
-dy
This option specifies that a skeleton file is created for each interface definition. This option must be used
to create a server application in library format. The option is always valid when the skeleton language
mapping is for COBOL or OOCOBOL. Refer to the “Names of files created” section above for filenames.
21-8
IDLc
-oprefix
This option specifies that the “xx” in the filename invoked from xx.idl is changed to the prefix specified by
prefix. This option is invalid when the language mapping is for Java.
-Sname
This option specifies that the name specified by name is attached at the beginning of a function name.
This option is valid when the skeleton language mapping is for the C language.
-Tdir
This option specifies the location at which to create a compiler work file. If this option is omitted, the
value set as the TEMP or TMP environment variable is assumed.
-mapinfo
This option creates a mapping information file, and is valid when the mapping language is OOCOBOL (oocob). Refer to the “Mapping Information File” section below for details.
-f
Enables the inconsistency detection function of interface information and stub. This option is effective
only when the mapping language is other than OOCOBOL.
When this option is specified, the compiler execution time increases slightly. If the compiler processing
fails, specify a longer wait time (period_receive_timeout parameter of config file) before the server
method returns to the client.
-nolog
Invalidate the trace acquisition function of the CORBA Service. When this option is omitted, the trace
information is not acquired by the stub skeleton.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Mapping Information File
Mapping information file is the file which class names of interface, data type and user exception
declared in IDL file are output in. The file name's suffix is “inf”. When a class name exceeds 30
characters, it is shortened. and this file is used to confirm the shortened class name. Use the classes in
this file when describing class in application programs, or specifying file name to be linked invoking
compiler. Refer to Table 21-8.
Table 21-8 Mapping Information File Names
Name
Use
1
Item
<interface> - </interface>
Tag name
Interface information (*1)
Content
-
-
2
<typedef> - </typedef >
Data type information (*1)
-
-
3
<exception> </exception>
User exception
information (*1)
-
-
21-9
Chapter 21: Application Development Commands
Item
4
Tag name
<map name=”a” type=”b”>
- </map>
Content
Name
Use
-
-
-
Mapping information for
each declaration (*2)
a: Full scope name
b: Type (See Note)
5
<name> - </name>
Data type name
-
6
<class> - </class>
Class name
-
7
<class-file> - </class- file>
Class file name
“class name”.cob
*4
8
<helper> - </helper>
Helper class name
“class name”--H/
“data type name”--H
*3
9
<helper- file> - </helperfile>
Helper class file name
“class name”--helper.cob/
“data type name”-helper.cob
*4
10
<stub> - </stub>
Stub class name
“class name”--S
*3
11
<stub-file> - </stub- file>
Stub class file name
“class name”--stub.cob
*4
12
<narrow- stub> </narrow- stub>
Narrow stub file name
“class name”-NarrowStub.cob
*4
13
<narrow- skel> - </narrowskel>
Narrow skeleton file name
“class name”-NarrowSkel.cob
*4
14
<new-impl> - </new- impl>
Implementation
registration file name
“class name”--NEW.cob
*4
15
<tie> - </tie>
tie class name
“class name”--T
*3
16
<tie-file> - </tie-file>
tie class file name
“class name”--tie.cob
*4
*1) Includes information in Item 4
*2) Includes information in Item 5
*3) Class name to be specified in application programs
*4) File name to be linked during compilation
Note
The targeted IDL declarations and types are as shown in Table 21-9.
Table 21-9 Targeted IDL Declarations and Types
Declaration
21-10
Type
interface
interface
typedef
typedef
exception
exception
struct (fixed )
struct-fixed
struct (variable)
struct-variable
union
union
*3
IDLc
Declaration
Type
enum
enum
sequence
sequence
string (size specified)
string
wstring (size specified)
wstring
fixed
fixed
Notes
•
The suffix ”idl” of the IDL file must be entered in small letters. If it is entered in capital letter in case
when it is imported by the use of the ftp command, change the name into the small letter and then
execute the IDLc command.
•
When using the IDLc command, specify the following path in the OD_HOME environment variable:
Windows®: OD_HOME=C:\Interstage\ODWIN
Solaris OE: OD_HOME=/opt/FSUNod
Linux: OD_HOME=/opt/FJSVod
•
The following words are used as keywords in the IDLc command, and must not be used when
creating IDL files:
cdr, con, env, failed, method, object, reply_status, request, response_expected, result, type
•
When the IDLc command is forcibly terminated with [ctrl]+[c], work file (generated under the -T
option, or TEMPERATURE or TMP environment variable settings ) may remain. In this case, delete
the following files:
Windows®: Windows® system directory\temp\IDLc.*
Solaris OE/Linux: /tmp/IDLc.*
•
Any parameter not beginning with a hyphen will be treated as an IDL file name.
•
When making a sequence type inheritance declaration in C and C++ mapping, a typedef warning
message will be displayed at compile, but this can be ignored.
•
Do not perform registration and update at the same time to the interface repository of the same IDL
definition from two or more command entry displays or two or more clients.
•
Execution of the IDLc command uses /usr/ccs/lib/cpp. Therefore, during operating system
installation, specify developer’s system support or higher as the install mode.
•
Software products required for developing the application are required.
21-11
Chapter 21: Application Development Commands
Error Messages
Compilation Error Messages
Can't open file :n
Error
The file indicated by “file” cannot be opened.
System error number: n
Read failed file
Error
Reading of the file indicated by “file” failed.
Write failed file
Error
Output to the file indicated by “file” failed.
MALLOC:name: n Bytes: Not enough memory
Error
There is insufficient memory to allocated “n” bytes for “name”.
Syntax error:string
Error
A syntax error was found in the definition of “string,” or an error was found in the content indicated by
“string.”
Structure member redeclaration of name
Error
The structure member “name” was redefined.
Union-switch member redeclaration of name
Error
The union-switch member “name” was redefined for a union.
Duplicate case in union-switch, label
Error
A duplicate label indicated by “label” was defined for a union.
Out of array dimension
Error
An array dimension is outside the specified range.
Identifier redeclaration of name
Error
The identifier “name” was redefined.
21-12
IDLc
Illegal scoping name
Error
The name indicated by “name” is invalid for this scope.
name undefined data type
Error
“name” has not been defined as a data type.
name is not data type
Error
“name” is not a data type.
Illegal union-switch data type, name
Error
“name” is not a valid union-switch data type.
Identifier too long.max(n)
Error
The identifier length exceeded the maximum limit. The maximum limit is n.
name undefined exception
Error
“name” has not been defined as an exception.
name is not exception
Error
“name” is not an exception definition.
Warning:duplicate raises name exception
Warning
The definition of the “name” exception was duplicated in a Raises clause.
name undefined interface
Error
The “name” interface has not been defined.
name is not interface
Error
“name” is not an interface.
Warning:duplicate inheritance name interface
Warning
Inheritance of “name” interface was duplicated.
21-13
Chapter 21: Application Development Commands
name undefined constant
Error
“name” has not been defined as a constant.
name is not constant
Error
“name” is not a constant.
Illegal constant type, name
Warning
“name” is not a valid constant type.
Warning:operator operator, out of range
Warning
The operand on the right of the shift operator “operator” is outside the valid range.
Operator operator, division by zero
Error
The second expression of operator “operator” is zero.
Overflow, Floating point value
Error
A floating-point value overflowed.
Bad assignment values, type1 : type2
Error
Values cannot be assigned because “type1” and “type2” are different types.
Warning:overflow signed long
Warning
A signed long value overflowed.
Illegal expression, type
Error
“type” is not a valid exception definition.
Syntax error hexadecimal, string
Error
Characters that cannot be specified as a hexadecimal number were specified in “string.”
Syntax error octal, string
Error
Characters that cannot be specified as an octal number were specified in “string.”
21-14
IDLc
Undefined escape character, string
Error
“string” has not been defined as an escape character. Unsupported multiple source file.
Unsupported multiple sourcefile
Error
Multiple definition of an IDL file.
Positive-integer constant only
Error
Only positive integer constants can be specified.
Ambiguous variable usage
Error
Variable declaration is ambiguous.
Can't close “file-name”
Error
The file indicated by “file” cannot be closed.
REALLOC:”name” : n Bytes
Error
The memory allocation indicated by “name” with the size n-bytes failed.
CORBA_ORB_init ERROR
Error
CORBA Service (ObjectDirector) is not started.
CORBA_ORB_BOA_init ERROR
Error
CORBA Service (ObjectDirector) is not started.
can't make temp list
Error
The working files can't be created because it is short of the disk resources.
Unsupported data type : “type”
Error
The data type defined as “type” is not supported.
Directory Create Failed : “name”
Error
The directory which class files are stored in can't be created.
21-15
Chapter 21: Application Development Commands
Other Messages
If the Interface Repository and Naming Service are used during language mapping by the IDLc
command and an environment setting or communication error causes IDL file compilation to fail, an
error message will be displayed, as follows:
Table 21-10 Process Name and Function Name
Processing phase (I/R):
Process name and function name
IDL:
Exception code
IDLc:
Stop.processing-phase status = termination status
Processing Phase
IDLparser:
Syntax analysis on IDL file
IDLcg:
Mapping in C language
IDLcppg:
Mapping in C++ or Visual C++ language
IDLjavacg:
Mapping in Java
IDLcobolcg:
Mapping in COBOL
IDLoocobcg:
Mapping in OOCOBOL
IDLinst:
Registration, change, or deletion of information in or from Interface
Repository
IDLSOAPcg
CORBA/SOAP gateway mapping
Destroy_rep
Termination processing
Process Name and Function Name
Information is displayed indicating where the IDLc command error was detected.
Exception Code
The following exception codes can be displayed to indicate a system exception:
IDL:CORBA/StExcep/UNKNOWN:1.0
An unknown exception occurred.
IDL:CORBA/StExcep/BAD_PARAM:1.0
An invalid parameter was found.
IDL:CORBA/StExcep/NO_MEMORY:1.0
Memory shortage occurred.
IDL:CORBA/StExcep/IMP_LIMIT:1.0
The number of concurrently activated server applications reached the maximum limit.
IDL:CORBA/StExcep/COMM_FAILURE:1.0
A communication error occurred. Communication with the Interface Repository service was disabled.
IDL:CORBA/StExcep/INV_OBJREF:1.0
Object reference is invalid.
21-16
IDLc
IDL:CORBA/StExcep/NO_PERMISSION:1.0
The user is not authorized for method execution.
IDL:CORBA/StExcep/INTERNAL:1.0
An internal error occurred in ObjectDirector.
IDL:CORBA/StExcep/MARSHAL:1.0
A marshaling error was detected in a parameter or result.
IDL:CORBA/StExcep/INITIALIZE:1.0
Initialization of ObjectDirector failed.
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Interface Repository service has not been activated.
IDL:CORBA/StExcep/BAD_TYPECODE:1.0
Type code is invalid.
IDL:CORBA/StExcep/BAD_OPERATION:1.0
Operation is invalid.
IDL:CORBA/StExcep/NO_RESOURCES:1.0
Resources are not enough for requests.
IDL:CORBA/StExcep/NO_RESPONSE:1.0
Interface Repository service does not respond.
IDL:CORBA/StExcep/PERSIST_STORE:1.0
Persistent storage failed.
IDL:CORBA/StExcep/BAD_INV_ORDER:1.0
Routine calling is abnormal.
IDL:CORBA/StExcep/TRANSIENT:1.0
An error occurred during transition. The request is reissued.
IDL:CORBA/StExcep/FREE_MEM:1.0
Memory release failed.
IDL:CORBA/StExcep/INV_IDENT
Syntax of identifier is invalid.
IDL:CORBA/StExcep/INV_FLAG:1.0
Flag is invalid.
IDL:CORBA/StExcep/INTF_REPOS:1.0
An error occurred during access to the Interface Repository.
IDL:CORBA/StExcep/CONTEXT:1.0
An error occurred in a context object.
21-17
Chapter 21: Application Development Commands
IDL:CORBA/StExcep/OBJ_ADAPTER:1.0
An error occurred in the object adapter.
IDL:CORBA/StExcep/DATA_CONVERSION:1.0
A data conversion error occurred.
Handling the Exception Codes
The system exceptions due to environment setting errors, and their corrective actions are as follows:
Exception code
IDL:CORBA/StExcep/NO_MEMORY:1.0
Cause
A shortage of system memory was detected.
Measures
Expand the system and swap memory.
Exception code
IDL:CORBA/StExcep/COMM_FAILURE:1.0
Cause
Communication with the Interface Repository service failed due to one of the following causes:
21-18
a)
Communication with the server is disabled because it has not been turned on, or the CORBA
Service has not been started.
b)
The interface repository processing is not completed within the irconfig ir_timeout period (default
value: 1,800 seconds).
c)
An attempt was made to process data that exceeded the size specified by
max_UNO_IIOP_msg_size in config (on the server or client). The default is 65,536 bytes.
d)
The number of requests to the server has exceeded the maximum limit specified by
max_IIOP_resp_con in config. The default is 8.
e)
An error occurred in the network environment.
f)
An error was found in the inithost/initial_hosts setting.
g)
The Interface Repository service for the value interface is not started (for EJB application
development).
IDLc
Measures
Corrective action is as follows:
a)
Connect power to the server and turn it on, then start the Interface Repository server.
b)
Set a larger value in the ir_timeout parameter of irconfig, and restart the interface repository.
c)
Set a larger value in the max_UNO_IIOP_msg_size parameter of config for the server and client,
and restart the CORBA Service.
d)
Set a larger value in the max_IIOP_resp_con parameter of config, and restart the CORBA Service.
e)
Check the network environment. If there is a problem, correct it.
f)
Check the inithost/initial_hosts file.
g)
For EJB application development, specify the EJB option in the Interstage initialization processing.
Note
There are cases when the interface repository fails its startup after the measure of the above item b) is
implemented. Take an appropriate measure by referring to the message that is output. For details of the
messages, refer to Messages.
Exception code
IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
Cause
The Interface Repository server has not been started.
Measures
Start the Interface Repository server. If startup fails, review the environment setup and retry startup. For
EJB application development, specify the EJB option in the Interstage initialization processing.
Exception code
IDL:CORBA/StExcep/NO_RESOURCE:1.0
Cause
The object used to call the Interface Repository service cannot be invoked, or a server with the same
implementation ID has already been started.
Measures
Retry processing later, or stop the server with the duplicate implementation ID, and review
implementation IDs.
Termination Status
2 = A syntax error occurred.
3 = An unsupported process was invoked.
4 = Another error was detected.
21-19
Chapter 21: Application Development Commands
Examples
The following IDLc command example compiles the sample.idl file, with the macro “DEBUG = 1”
specified. A work file is created as follows.
IDLc
-DDEBUG
-TC:\tmp1
IDLc
-DDEBUG
-T/tmp1
sample.idl
sample.idl
The following IDLc command example compiles the foo.idl file (default). Files to be included are
searched for in C:\home\ORB\include\IDL. Information is not registered in the Interface Repository.
21-20
IDLc
-IC:\home\ORB\include\IDL
IDLc
-I/home/ORB/include/IDL
otslinkrsc
otslinkrsc
Name
otslinkrsc
Creates a Resource Manager.
Synopsis
otslinkrsc -l xa_linkpgm [-t { process|thread }] -r “library” -o name
Description
This command creates a Resource Manager. Specify the name of an XA linkage program at xa_linkpgm.
Specify the library information (provided by the database vendor) required to link the XA at library.
Specify the name of a Resource Manager to be created at name.
Execution of this command operates the link command of Microsoft® Visual® C++.
The options of this command are as follows:
-l
Specify a file extension “LIB” created by the otsmkxapgm command.
Specify a file extension “o” created by the otsmkxapgm command.
When the program for XA cooperation is in the current directory at the time of command execution, a
command can be executed by specification of only a file name.
The maximum path name length that can be specified for an XA linkage program is 255 bytes.
-t { process|thread }
When process is specified, it is created in process mode.
When thread is specified, it is created in thread mode.
Assumed to be process if omitted.
21-21
Chapter 21: Application Development Commands
-r
The library which the database vendor opens to the public is specified within 1024 bytes.
Specify a command depending on the database:
Symfoware/RDB:
“/libpath:'library storage path' F3CWXA.LIB F3CWDRV.LIB”
Oracle V8.0.x:
“/libpath: 'library storage path' XA80.LIB”
Oracle V8.1.x:
“/libpath: 'library storage path' ORAXA8.LIB”
Oracle V9.0.x:
“/libpath: 'library storage path' ORAXA9.LIB”
SQL Server 7.0:
“XASWITCH.OBJ”
The library which the database vendor opens to the public is specified within 2048 bytes.
Specify a command depending on the database:
Symfoware/RDB:
“-L'library storage path' -lrdbxam -lsqldrvm”
Oracle V8.1.x:
“-L'library storage path' -lclntsh -lclient8 -lsql8 -lcommon8 –lcore8 lnls8”
Oracle V9.0.x:
“-L'library storage path' -lclntsh -lclient9 -lsql9 -lcommon9 -lcore9 lnls9”
The library which the database vendor opens to the public is specified within 2048 bytes.
Specify a command depending on the database:
Oracle V9.0.x:
“-L'library storage path' -lclntsh -lclient9 -lsql9 -lcommon9 -lcore9 lnls9”
Note
It is necessary to enclose library information and object information with normal-width double quote (“).
It is necessary to enclose the storage passing in the library with normal- width single quote (').
-o
Specifies the name of a Resource Manager to be created.
The maximum path name length that can be specified for a Resource Manager name is 255 bytes.
The file name which attached the extension “EXE” is specified. Specification never cares about neither
the absolute path nor the file name. But, In file name specification, it is created by the current directory
at the time of command execution.
21-22
otslinkrsc
Notes
•
At the -r option, do not specify any library other than those provided by the database vendor.
•
When using the otslinkrsc command, Microsoft® Visual® C++ is needed.
•
Set the following environment variables set in the user environment variable by installing SQL
Server in the system environment variable before executing the command when you make the
resource management program for SQL Server.
PATH
INCLUDE
LIB
•
If the otslinkrsc command has resulted in an error, there can be a case when the message that
outputs the Microsoft® Visual® C++, is output. In such a case, take an appropriate measure
referring to the Microsoft® Visual® C++ Manual.
•
At the time of command execution, the Database Linkage Service (service name:
ObjectTransactionService) and CORBA Service (service name: OD_start, Naming Service) need to
be started. When these services have stopped, supply a command after starting the service
manually.
•
Do not overwrite an executable file of the activated resource management program. If a file already
exists at execution of the command, the system asks if the file can be overwritten. Confirm
whether the file operates as a process.
•
The following resource management programs are provided in /opt/FSUNots/program/xa. There is
no need to create further resource management programs if operation remains within the limits of
the following programs.
−
−
−
−
Resource management program for Oracle9i (fjotsrsc_ora9i) (Process mode).
Resource management program for Oracle8i (fjotsrsc_ora81) (Process mode).
Resource management program for Symfoware/RDB (libotsxasym.o) (Process mode)
Resource management program for MQD (libotsxamqd.o) (Process mode)
•
When using Symfoware/RDB on Solaris, specify the library of the product required in
SymfoWARE/RDB in the environment variable LD_LIBRARY_PATH, and execute this command.
•
Messages may sometimes be output by SPARCompiler when an error occurred with the otslinkrsc
command. Refer to the SPARCompiler manual for further details.
•
The following resource management program is provided in /opt/FJSVots/program/rsc. There is no
need to create further resource management programs if operation remains within the limits of the
following program.
−
•
Resource management program for Oracle9I (fjotsrsc_ora91) (Process mode).
The C compiler is required to use the otslinkrsc command.
21-23
Chapter 21: Application Development Commands
Examples
•
When resource control program “rdb_resource.exe” which uses Symfoware/RDB is created.
otslinkrsc -l D:\temp\ots\otssymxa.lib
-r “/libpath:'C:\Program Files\SFWSV\ESQL\LIB'
F3CWXA.LIB F3CWDRV.LIB”
-o rdb_resource.exe
•
When the resource control program “name.exe” which uses Oracle Version 8.0.5 is created.
otslinkrsc -l D:\temp\ots\otsoraxa.lib
-r “/libpath:'C:\ORANT\RDBMS80\XA' XA80.LIB “
-o rdb_resource.exe
•
When the resource control program “name.exe” which uses SQL Server Version 7.0 is created.
otslinkrsc -l D:\temp\ots\otsmsqlxa.lib
-r “XASWITCH.OBJ “
-o rdb_resource.exe
•
When creating a Resource Manager (rdb_resource) that uses Symfoware/RDB, specify the
Symfoware/RDB library directory in the environment variable RDB2LIB.
otslinkrsc -l libotssymxa.o -t thread -r “-L$(RDB2LIB)
-o rdb_resource
•
-lrdbxam -lsqldrvm”
When the resource management program “rdb_resource” which uses Oracle Version 8.1.5 is
created. It is necessary to specify the Oracle library directory in the ORALIB environment variable.
otslinkrsc -l libotssymxa.o -r “-L$(ORALIB) -lclntsh -lclient8
-lsql8 -lcommon8 -lcore8 -lnls8” -o rdb_resource
When the resource management program “rdb_resource” which uses Oracle Version Oracle9i Database
Release2(9.2.0.1.0) is created. It is necessary to specify the Oracle library directory in the ORALIB
environment variable. When using Oracle, be sure to create the resource management program in the
thread mode.
otslinkrsc -l libotsoraxa.o -t thread -r “-L$(ORALIB) -lclntsh -lclient9
-lsql9 -lcommon9 -lcore9 -lnls9” -o rdb_resource
21-24
otsmkxapgm
otsmkxapgm
Name
otsmkxapgm
Creates a program for XA linkage.
Synopsis
otsmkxapgm [-java] | [-t {process|thread}] -s switch_name... -r "library" -o
name
otsmkxapgm [-java -r "library"] | [-t {process|thread}] -s switch_name... -o
name
Description
This command considers the program for server application enabling XA linkage with a database as a
library file, and creates it two.
Input the name of the database structure xa_switch_t and output filename with the otsmkxapgm
command.
Moreover, the library which a database vendor exhibits is also specified. Specify the –java option to
create XA link programs for Java server applications.
In addition, execution of this command operates the compile command and the link command of
Microsoft® Visual® C++.
This command considers the program for the server application enabling XA linkage with a database as
an object file.
Input the name of the database structure xa_switch_t and output filename with the otsmkxapgm
command.
In creating the program for XA cooperation for multi-resource linkage, it specifies a xa_switch_t structure
object name by the number which cooperates.
The options and arguments of this command are as follows:
21-25
Chapter 21: Application Development Commands
-s
Specifies an XA linkage database xa_switch_t structure name.
Multiple options and arguments can also be specified. It should not be omitted.
-java
The program for XA linkage using the Java language for server applications (Java server) is created.
Specify this option only when creating the program for XA linkage for Java servers.
libthread.so is linked to the XA linkage program for Java servers.
libpthread.so is linked to the XA linkage program for Java servers.
-r
Specify the libraries provided by the database vendor (up to 1024 bytes).
Specifies the library provided by the database vendor. It is not omissible.
Specify a command by the following agreement.
Symfoware/RDB:
“/libpath:'library storage path' F3CWXA.LIB F3CWDRV.LIB”
Oracle V8.0.x:
“/libpath: 'library storage path' XA80.LIB”
Oracle V8.1.x:
“/libpath: 'library storage path' ORAXA8.LIB”
Oracle V9.0.x:
“/libpath: 'library storage path' ORAXA9.LIB”
SQL Server 7.0:
“XASWITCH.OBJ”
In addition, when creating the XA linkage program for multi-resources, a blank character is divided and
two or more information specified by the following agreement is specified as a character.
-r “/libpath:'librarypathname' /libpath:'librarypathname'… libraryname…”
librarypathname: Library path name
librarypath: The library name which each database vendor exhibits
Notes
It is necessary to enclose library information and object information with normal-width double quote (“).
It is necessary to enclose the storage passing in the library with normal-width single quote (').
Specify the libraries provided by the database vendor (up to 2048 bytes).
Specify a command by the following agreement.
21-26
Symfoware/RDB:
“-L'library storage path' -lrdbxam –lsqldrvm”
Oracle V8.1.x:
“-L'library storage path' -lclntsh -lclient8 -lsql8 -lcommon8 -lcore8 –lnls8”
otsmkxapgm
Oracle V9.0.x:
“-L'library storage path' -lclntsh -lclient9 -lsql9 -lcommon9 -lcore9 -lnls9”
Notes
It is necessary to enclose library information and object information with normal-width double quote (“).
It is necessary to enclose the storage passing in the library with normal-width single quote (').
Specify the libraries provided by the database vendor (up to 2048 bytes).
Specify a command by the following agreement.
Oracle V9.0.x:
“-L'library storage path' -lclntsh -lclient9 -lsql9 -lcommon9 -lcore9 -lnls9”
Notes
It is necessary to enclose library information and object information with normal-width double quote (“).
It is necessary to enclose the storage passing in the library with normal-width single quote (').
-t {process|thread}
When process is specified, it is created in process mode.
When thread is specified, it is created in thread mode.
Assumed to be process if omitted.
-o
Specifies the name of a XA linkage program to be output. The maximum path name length that can be
specified for an XA linkage program is 255 bytes.
This option is not omissible.
Moreover, give the extension of a file as a “DLL.” Extension of the specified file “DLL” and the library
file of “LIB” are created as a result of a command. Specification never cares about neither the absolute
path nor the file name. But, In file name specification, it is created by the current directory at the time of
command execution.
Usually, please give the extension of a file as "o." Moreover, when you specify it as -java simultaneously,
please give the extension of a file as "so." In file name specification, it is created by the current directory
at the time of command execution although a path name or a file name is sufficient as specification
absolutely.
Notes
•
The XA linkage program for multiple resource linkage can be used only when creating server
applications.
21-27
Chapter 21: Application Development Commands
•
To use the multi resource access function, an XA linkage program and definition (WorkUnit
definition and definition information for Implementation Repository registration) must be created
(Tables 21-11 and 21-12). While doing this, the Database Linkage Service WorkUnit invoke or init
methods can be terminated abnormally.
Table 21-11 XA Linkage Program - Single and Multiple Resource Access
XA linkage
program
Register the WorkUnit definition in the OD
Invoke the WorkUnit and Database
Linkage Service Init method
For one
resource
access
One resource definition file specification
Completes successfully
Specification of the resource definition
file of the same resource classification is
plurality.
Completes successfully
Specification of the resource definition
file of a different resource classification is
plurality.
Terminates abnormally
One resource definition file specification
Terminates abnormally
Multiple resource definition file
specifications
If the RM name exists, then completes
successfully, otherwise, terminates
abnormally
For multiple
resource
access
Table 21-12 XA Linkage Program - Single and Multiple Resource Access
XA linkage
program
Register the WorkUnit definition in the OD
Invoke the WorkUnit and Database
Linkage Service Init method
For one
resource
access
One resource definition file specification
Completes successfully
Multiple resource definition file
specifications
Terminates abnormally
One resource definition file specification
Terminates abnormally
Multiple resource definition file
specifications
If the RM name exists, then completes
successfully, otherwise, terminates
abnormally
For multiple
resource
access
•
21-28
The library file of two extensions, “DLL” and “LIB”, is made. The file of extension”LIB” of a file
becomes the input information of otslinkrsc command and tdlinkapm command. Moreover, the
library file of extension “DLL” of a file should set the storing place of a file as system environment
variable PATH, when you employ a resource control program.
otsmkxapgm
•
When using otsmkxapgm command, Microsoft® Visual® C++ is needed. Moreover, please set the
environment variable of the following set as a user environment variable as a system environment
variable by installation of Microsoft® Visual® C++ before executing a command.
PATH
INCLUDE
LIB
•
The XA linkage program for Java server applications can be used only when creating server
application.
•
Please set the following environment variables set in the user environment variable by installing
SQL Server in the system environment variable before executing the command when you make the
resource management program for SQL Server.
PATH
INCLUDE
LIB
•
When a command carries out an unusual end at the time of otsmkxapgm command execution,
momentary work files (file name:otsenvxamkpgm.c) may not be collected. In this case, please
delete the directory and the temporary work file created by the following environmental
subordinates. The directory name created is otsmkxapgmnnnnnn_nn. (nnnnnn: Process ID of
command, nn: The arbitrary numerical values of 2 figures)
−
−
−
It is the subordinate if there is an environment variable TMP.
It is the subordinate, if there is no environment variable TMP and there is TEMP.
If there are no environment variables TMP and TEMP, it is a current directory subordinate at
the time of command execution.
•
At the time of command execution, the Database Linkage Service (service name:
ObjectTransactionService) and CORBA Service (service name: OD_start, Naming Service) need to
be started. . When these services have stopped, supply a command after starting the service
manually.
•
The following XA linkage programs are provided in /opt/FSUNots/program/xa. There is no need to
create further XA linkage programs if operation remains within the limits of the following programs.
−
−
−
−
−
•
XA linkage program for Oracle (libotsxaora.o) (Process mode)
XA linkage program for Symfoware/RDB (libotsxasym.o) (Process mode)
XA linkage program for MQD (libotsxamqd.o) (Process mode)
XA linkage program when using Oracle and MQD (libotsxamqd_ora.o) (Process mode)
XA linkage program when using Symfoware/RDB and MQD (libotsxamqd_sym.o) (Process
mode)
A SPARCompiler is needed when using the otsmkxapgm command.
21-29
Chapter 21: Application Development Commands
•
The following XA linkage program is provided in /opt/FJSVots/program/xa. There is no need to
create further XA linkage programs if operation remains within the limits of the following program.
−
•
XA linkage program for Oracle (libotsxaora.o) (Process mode)
A compiler is needed when using the otsmkxapgm command.
Examples
•
When the XA linkage program for Symfoware “otssymxa.dll” is created
otsmkxapgm -s RDBII_xa_switch
-r “/libpath:'c:\Program Files\SFWSV\ESQL\LIB'F3CWXA.LIB
F3CWDRV.LIB”
-o D:\temp\ots\otssymxa.dll
•
When the XA linkage program for Oracle “otsoraxa.dll” is created
In addition, the version of Oracle is 8.0.5.
otsmkxapgm -s xaosw
-r “/libpath:'C:\Oracle\Ora81\RDBMS\XA' ORAXA8.LIB “
-o D:\temp\ots\otsoraxa.dll
•
When the XA linkage program for SQL Server “otsmsqlxa.dll” is created. In addition, the version of
SQL Server is 7.0.
otsmkxapgm -s msqlsrvxa1
-r”XASWITCH.OBJ”
-o D:\temp\ots\otsmsqlxa.dll
•
When the XA linkage program for Symfoware (for Java server applications) “otssymxaj.dll” is
created.
otsmkxapgm -java -s RDBII_xa_switch
-r”/libpath:'C:\Program Files\SFWSV\ESQL\LIB' F3CWXA.LIB
F3CWDRV.LIB”
-o D:\temp\ots\otssymxaj.dl
•
When one program for XA cooperation which cooperates with Symfoware and two databases of
Oracle is created (when accessing two databases on one application).
otsmkxapgm -s RDBII_xa_switch -s xaosw
-r “/libpath:'C:\Program Files\SFWSV\ESQL\LIB'
/libpath:'C:\Oracle\Ora81\RDBMS\XA' F3CWXA.LIB F3CWDRV.LIB
ORAXA8.LIB”
-o D:\temp\ots\otsmultixa.dll
21-30
otsmkxapgm
•
When creating the XA linkage program “otssymxa.o” for Symfoware in thread mode.
otsmkxapgm -t thread
•
-s RDBII_xa_switch -o otssymxa.o
When one program for XA cooperation "otsmultixa.o" which cooperates with Symfoware and two
databases of Oracle is created (when accessing two databases on one application)
otsmkxapgm -s RDBII_xa_switch -s xaosw -o otsmultixa.o
•
When creating the XA linkage program (for Java server applications) “libsymxaj.o” for Symfoware.
The Symfoware/RDB library directories must be specified in the RDB2LIB environment variable.
otsmkxapgm –java –r “-L$(RDB2LIB) –lrdbxa –lsqldrv” -s RDBII_xa_switch
-o libsymxaj.so
•
When creating the XA linkage program “otsoraxa.o o” for Oracle.
otsmkxapgm -s xaosw -o otsoraxa.o
21-31
Chapter 21: Application Development Commands
tdc
Name
tdc
The TD Compiler
Synopsis
tdc [{-c | -cpp | -cobol | -java | -vcpp|-oocob}]
[{-mc | -mcpp | -mcobol | -mvcpp}]
[{-create | -update | -delete}]
[-D<name>=<Value>] [-I<includedir>] [-T<tmpdir>]
[{-www | -wwwex}] [-R] [-F] [-cdecl] [-noex] [-f] [-M Systemname]
[-W<WrapperDefinitionFilename>]
[IDLDefinitionFilename]
Description
This command generates source files of stub and skeleton from the specified IDL definition file.
The options and arguments of this command are as follows:
[Mapping language option (Stub generation)]
Any of the following options can be specified to specify a mapping language. Two or more of these
options cannot be specified simultaneously.
If no option is specified, -cobol is assumed.
If no option is specified, -c is assumed.
-c
Generates a stub file mapped to C.
-cpp
Generates a stub file mapped to C++.
-cobol
Generates a stub file mapped to COBOL.
21-32
tdc
-oocobol
Generates a stub file mapped to OOCOBOL (object oriented COBOL).
-java
Generates a stub file mapped to Java (OMG mapping).
-vcpp
Generates a stub file mapped to Microsoft® Visual® C++.
[Mapping language option (Skeleton generation)]
Any of the following options can be specified to specify a mapping language. Two or more of these
options cannot be specified simultaneously.
If no option is specified, -mcobol is assumed.
If no option is specified, -mc is assumed.
-mc
Generates a skeleton file mapped to C.
-mcpp
Generates a skeleton file mapped to C++.
-mcobol
Generates a skeleton file mapped to COBOL.
-mvcpp
Generates a skeleton file mapped to Microsoft® Visual® C++.
[Handling of interface information]
These options specify how to handle interface information generated by the TD compiler. If all are
omitted, -create is assumed.
The options are detailed as follows:
-create
Registers interface information with the Interface Repository. If the same identifier is already registered,
an error occurs and the TD compiler stops.
-update
Registers interface information with the Interface Repository. If the same identifier is already registered,
the interface information is updated. This option must be specified when changing the IDL file.
21-33
Chapter 21: Application Development Commands
-delete
Deletes interface information from the Interface Repository. Note that an unregistered identifier causes
the delete option to fail.
[Client linkage mode]
Specifies the client linkage mode provided by the TD. If both options are omitted, the use of CORBA
client linkage (basic function) is assumed.
Details of each option are explained below.
This option is intended for compatibility with Interstage V2.1 and earlier.
-www
When this option is specified, the use of WWW basic linkage (basic function) is assumed.
-wwwex
When this option is specified, the use of WWW simple application linkage (extended function) is
assumed.
[Other options]
-D<name>=<Value>
Defines the macro specified in name. This is the same as the #define name Value defined at the
beginning of the IDL definition file. When =value is omitted, it is generated as #define name.
-I<includedir>
Adds the directory specified in includedir to the directory list searched for in the file specified at #include.
This option can be defined more than once. In that case, the directories are searched for in the order in
which they were specified.
-T<tmpdir>
Specifies the location of the temporary work file to be created by the compiler.
If this option is omitted, c:\temp is assumed.
If this option is omitted, /temp is assumed.
-R
When this option is specified, stub and skeleton files are not generated and only the Interface
Repository is registered.
-F
This option specifies that stub and skeleton files are generated without registering the Interface
Repository.
21-34
tdc
-cdecl
This option specifies that the INTRA_PROCESS function is called according to C syntax. This option is
valid for mapping language C++ (-cpp).
-noex
This option specifies that exception processing is invoked by the CORBA::Environment method. If this
option is omitted, exception processing is invoked by the try catch method.
When the mapping language is C++ language and Visual C++ language, it is effective.
What is specified is recommended when using C++ language and Visual C++ language.
When the mapping language is C++ language, it is effective.
What is specified is recommended when using C++ language.
-f
Specify this option to use the interface check function.
-M<system-name>
Define a target system name to use an extended system. A default system is applicable when this
option is omitted.
-W<WrapperDefinitionFilename>
Specify the wrapper definition file for AIM linkage. If this option is omitted, the CORBA client is assumed.
IDLDefinitionFilename
Specifies the name of the IDL definition file. If this filename is omitted, Foo.idl is assumed.
The names of the files generated by the TD compiler are shown in Tables 21-13 to 21-29.
Server Application (COBOL)
Table 21-13 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub
-
-
Skeleton
TD_object name_skel.def
def file for skeleton (See Note 9 and 15)
TD_object name_skel.cbl
Skeleton file (See Note 4)
21-35
Chapter 21: Application Development Commands
CORBA Client Linkage
TD_object name-H.cbl (See Note 1)
Header file
TD_object name_skel_h.cbl
Data definition type file (See Note 6)
TD_object name_skel_alloc.cbl
alloc program file (See Note 11)
TD_object name_skel_allocbuf.cbl
allocbuf program file (See Note 17)
AIM Linkage
File name
-
Server Application (C)
Table 21-14 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/ Skeleton
File name
File type
Stub:
-
-
Skeleton:
TD_object name_skel.c
Skeleton file (See Note 4)
TD_object name.h
Header file
AIM Linkage
File name
-
Server Application (C)
Table 21-15 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
21-36
Stub/
Skeleton
File name
File type
Stub:
-
-
Skeleton:
TD_object name_skel.c
Skeleton file
TD_object name.h
Header file
tdc
Server Application (C++)
Table 21-16 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
-
-
Skeleton:
TD_object name_skel_c++.C
Skeleton file (See Note 4)
TD_aa.h
Header file
TD_aa_c++.C
Class method definition file
TD_object name_proto.h
Header file
AIM Linkage
File name
-
Server Application (C++)
Table 21-17 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
-
-
Skeleton:
TD_object name_skel_c++.C
Skeleton file
TD_aa.h
Header file
TD_aa_c++.C
Class method definition file
TD_object name_proto.h
Header file
21-37
Chapter 21: Application Development Commands
Server Application (Visual C++)
Table 21-18 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
-
-
Skeleton:
TD_object name_skel_c++.cpp
Skeleton file (See Note 4)
TD_aa.h
Header file
TD_aa_c++.cpp
Class method definition file
TD_object name_proto.h
Header file
AIM Linkage
File name
-
Client Application (C)
Table 21-19 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.c
CDR Source file
aa_stub.c
Stub file (See Note 4)
-
-
Skeleton:
AIM Linkage
File name
Attribute information (See Notes 2, 3 and 4)
21-38
tdc
Client Application (C)
Table 21-20 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.c
CDR Source file
aa_stub.c
Stub file
-
-
Skeleton:
Client Application (C++)
Table 21-21 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa.H
Common Header file
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.c
CDR Source file
aa_c++.C
Class method definition file
aa_stub_c++.C
Stub file (See Note 4)
-
-
Skeleton:
AIM Linkage
File name
Attribute information (See Notes 2, 3 and 4)
21-39
Chapter 21: Application Development Commands
Client Application (C++)
Table 21-22 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa.H
Common Header file
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.c
CDR Source file
aa_c++.C
Class method definition file
aa_stub_c++.C
Stub file
-
-
Skeleton:
Client Application (COBOL)
Table 21-23 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa_h.cbl
Common Header file
aa_cdr.cbl
CDR Header file
aa_cdr.def
def file
aa_stub.cbl
Stub file (See Note 4)
-
-
Skeleton:
(See Note
10)
AIM Linkage
File type
Attribute information (See Notes 2, 3 and 4)
21-40
tdc
Client Application (COBOL)
Table 21-24 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa_h.cbl
Common Header file
aa_cdr.cbl
CDR Header file
aa_cdr.def
def file
aa_stub.cbl
Stub file
-
-
Skeleton:
(See Note
10)
Client Application (Java) (See Note 5)
Table 21-25 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
bb.java
Interface class file (See Note 7)
bbOperations.java
Interface Operations file (See Note 7)
bbHelper.java
Helper class file (See Note 7)
bbHolder.java
Holder class file (See Note 7)
_bbStub.java
stub file (See Note 7)
bbPOATie.java
tie class file (See Note 8)
bbPOA.java
Skeleton class file (See Note 8)
cc.java
Data type class file (See Note 12 and 13)
ccHelper.java
Data type Helper file (See Note 12 and
13)
ccHolder.java
Data type Holder file (See Note 12 and
13)
sequence_dd_eeHelper.java
sequence type Helper file (See Note 14)
sequence_dd_eeHolder.java
sequence type Holder file (See Note 14)
-
-
Skeleton:
21-41
Chapter 21: Application Development Commands
CORBA Client Linkage
AIM Linkage
File type
Attribute information (See Notes 2, 3 and 4)
Client Application (Java) (See Note 5)
Table 21-26 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
bb.java
Interface class file (See Note 7)
bbOperations.java
Interface Operations file (See Note 7)
bbHelper.java
Helper class file (See Note 7)
bbHolder.java
Holder class file (See Note 7)
_bbStub.java
stub file (See Note 7)
bbPOATie.java
tie class file (See Note 8)
bbPOA.java
Skeleton class file (See Note 8)
cc.java
Data type class file (See Note 12 and 13)
ccHelper.java
Data type Helper file (See Note 12 and
13)
ccHolder.java
Data type Holder file (See Note 12 and
13)
sequence_dd_eeHelper.java
sequence type Helper file (See Note 14)
sequence_dd_eeHolder.java
sequence type Holder file (See Note 14)
-
-
Skeleton:
21-42
tdc
Client Application (Visual C++)
Table 21-27 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/ Skeleton
File name
File type
Stub:
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.cpp
CDR Source file
aa_c++.cpp
Class method definition file
aa_stub.cpp
Stub file (See Note 4)
-
-
Skeleton:
AIM Linkage
File type
Attribute information (See Notes 2, 3 and 4)
Client Application (Visual C++)
Table 21-28 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa.h
Common Header file
aa_cdr.h
CDR Header file
aa_cdr.cpp
CDR Source file
aa_c++.cpp
Class method definition file
aa_stub.cpp
Stub file
-
-
Skeleton:
21-43
Chapter 21: Application Development Commands
Client Application (OOCOBOL)
Table 21-29 CORBA Client Linkage Files Generated by TD Compiler
CORBA Client Linkage
Stub/
Skeleton
File name
File type
Stub:
aa-REP.cbl
Repository module declaration registry
aa-CONST.cbl
Constant declaration registry
aa-COPY.cbl
TYPEDEF type declaration registry
object name.cob
Interface file
object name-Helper.cob
Helper class file
object name-stub.cob
stub class file
object name-NarrowStub.cob
Narrow stub file
object name-cc.cob
Data type class file (See Note 16)
object name-cc--Helper.cob
Data type Helper file (See Note 16)
CORBA-STRING-dd-Helper.cob
Data type Helper file (See Note 16)
CORBA-WSTRING-dd-Helper.cob
Data type Helper file (See Note 16)
-
-
Skeleton:
AIM Linkage
File type
Attribute information (See Notes 2, 3 and 4)
aa, bb, cc, dd, ee are variables, where aa is the IDL filename, bb is an interface defined in the IDL file,
cc is the data type name, dd is the number of bound, and ee is the class name.
Note 1:
TD-ObjectName-H.cbl is generated when the const IDL definition is provided.
Note 2:
Each filename is detailed below.
Attribute information
Specified value of the inattrib or outattrib operands in the wrapper definition file
Template HTML file
TDTmpHTMLmoduleName_InterfaceName_OperationName.html
Parameter block class file
Name of the block class file for any input parameters
TDInputmoduleName_InterfaceName_OperationName.java
Name of the block class file for any output parameters
TDOutputmoduleName_InterfaceName_OperationName.java
21-44
tdc
Note 3:
Since the attribute information is controlled by the system, it will not be created in the
directory where the tdc command was executed, or where the IDL file exists.
Note 4:
Generated files depend on the following options:
When the -wwwex option is specified:
The template HTML file and parameter block class files are generated.
The name of block class file for any input parameters
If -www and -wwwex are omitted:
A stub file is generated.
When the -W option is specified:
Attribute information is generated.
When the -W option is omitted:
A skeleton file is generated.
Note 5:
In Java language mapping, files corresponding to the interface and data type within an
interface are created in separate sub directories.
Note 6:
The data type definition is stored. If necessary, refer to it while developing the application.
Note 7:
A sub directory is created in the tdc command directory with the name of the module
defined in the IDL file. Files are generated in the same sub directory.
Note 8:
The file is not used though it is generated.
Note 9:
The object name is registered in the skeleton definition file as a default library name. It can
be changed, if necessary.
Note 10:
The IDL file name_cdr.def file is generated, however, do not use it.
Note 11:
Structure data type including variable length is generated if it is defined.
Note 12:
The files are generated if the following data types are defined:
cc.java : structure type, exceptions
ccHelper.java : structure type, array type, sequence type, data types defined by typedef,
exceptions
ccHolder.java : structure type, array type, sequence type, exceptions
Note 13:
Each file, it is the current directory which supplied tdc command when a data type definition
was described besides a module definition, it is the directory carried out by note 7 when
described by module definition, when described by interface definition, a sub directory is
created by the name of interface name + Package which IDL file defined, and it is
generated under it.
Note 14:
If the sequence style is defined, it is generated in the directory from which the tdc
command was input.
Note 15:
In Windows NT® / Windows® 2000, it is generated.
21-45
Chapter 21: Application Development Commands
Note 16:
The files are generated if the following data types are defined:
object name-cc.cob:
Structure data type including variable length string or wstring and exception declarations
object name-cc—Helper.cob:
typedef declaration for fixed or variable length strings, typedef declaration for fixed or
variable length wstrings, structure data type including fixed or variable length string and
exception declarations, structure data type including fixed or variable length wstring and
exception declarations
CORBA-STRING-dd—Helper.cob:
typedef declaration for fixed length strings, structure data type including fixed length string
and exception declarations
CORBA-WSTRING-dd—Helper.cob:
typedef declaration for fixed length wstrings, structure data type including fixed length
wstring and exception declarations
Note 17:
Generated when sequence type is specified.
Notes
•
Before activating the TD compiler, it is necessary to set the TD install directory in the environment
variable TD_HOME, and the CORBA Service install directory in the environment variable
OD_HOME.
•
Do not use the following words when generating an IDL definition file, since they are reserved as
keywords:
cdr, con, env, failed, method, object, reply_status, request, response_expected, result, type,
TD_RTNVAL
•
When compiling the stub created with the -cpp option, specify -D_MULTI_LINK when using the c++
compiler.
•
A maximum of 255 characters can be specified for each filename generated by the TD compiler.
•
Do not separate the tdc command option and its option argument with a space.
•
When specifying the -delete option, specify the mapping language option to that specified during
registration.
•
Do not perform registration and update at the same time to the interface repository of the same IDL
definition.
•
When fulfilling the following two conditions at the time of cooperation between applications, the
double definition error of a function occurs at the time of compile.
−
−
From one client application, a call of two or more server applications is enabled.
The data type (except for a basic data type) of the same classification is declared to the IDL
definition used with each server application.
In this case, please change the outputted function name or generate a stub file using the IDLc
command (-lc or -ls option is specified). Please refer to IDLc for details of the IDLc command.
21-46
tdc
Error Messages
There are two types of message synopsis output from the TD compiler. The source of reference of the
detailed information is different depending on the message synopsis that is output.
•
When the messages are output with the synopsis of "tdc: Stop. Processing phase status = end
status", refer to other messages that are described.
•
When the messages are output with the synopsis of "tdc: Type of Messages:Messages
Number:Messages Contents", refer to Messages.
Examples
tdc IDl0001.idl
TD_HOME=/opt/FSUNtd
export TD_HOME
OD_HOME=/opt/FSUNod
export OD_HOME
tdc IDL0001.idl
TD_HOME=/opt/FJSVtd
export TD_HOME
OD_HOME=/opt/FJSVod
export OD_HOME
tdc IDL0001.idl
21-47
Chapter 21: Application Development Commands
21-48
Part 8
Maintenance Edition
Chapter 22
Backup Commands
This chapter details the Backup commands.
Note
The backup command can be used in the following products:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
In the Standard Edition, only the following commands can be used:
•
esbackupsys
esrestoresys
ippbackup
ipprestore
irdelete
iscbackupsys
iscrestoresys
isguibackup
isguirestore
issoapbackup
issoaprestore
j2eebackup
j2eerestore
ijsbackup
ijsrestore
obfbkup
obfrestore
odbackupsys
odexportir
odexportns
odimportir
odimportns
odrestoresys
otsbackupsys
otsrestoresys
tdbackupsys
tdrestoresys
Interstage Application Server Plus
In the Plus Edition, only the following commands can be used:
esbackupsys
esrestoresys
ippbackup
ipprestore
irdelete
iscbackupsys
iscrestoresys
isguibackup
isguirestore
issoapbackup
issoaprestore
j2eebackup
j2eerestore
jmsbackup
jmsrestore
ijsbackup
ijsrestore
obfbkup
obfrestore
odbackupsys
odexportir
odexportns
odimportir
odimportns
odrestoresys
otsbackupsys
otsrestoresys
tdbackupsys
tdrestoresys
•
Interstage Application Server Web-J Edition
22-1
Chapter 22: Backup Commands
In the Web-J Edition, only the following commands can be used:
22-2
ippbackup
ipprestore
ijsbackup
ijsrestore
j2eebackup
j2eerestore
esbackupsys
esbackupsys
Name
esbackupsys
Backup and export of resources for the Event Service
Synopsis
esbackupsys
-d directory [-M system]
Description
This command backs up and exports resources files used by the Event Service.
The following explains the arguments for this command.
-d directory
Specify the storage directory name (full pathname) of Event Service resources for backup/export with up
to 1024 bytes.
The following directory is created under the specified directory and Event Service resources are backed
up under the following directory. If the following directory already exists, delete the directory.
Windows®: ES
Solaris OE/Linux: FJSVes
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
22-3
Chapter 22: Backup Commands
Notes
•
Execute this command with administrator authority.
•
Stop the Event Service before backup.
•
Persistent data is excluded from backup.
•
The unit of backup is a definition file with the extension "def" under the following directory.
If a unit definition file which exists in a different directory is specified with "esmkunit -uf" when
creating a unit, it is not backed up. In this case, copy the unit definition file under the following
directory before performing backup or store it in the backup storage directory after backup is
performed.
When the esrestoresys command is executed the unit is created based on the unit definition file
stored in the following directories. Therefore, it fails in the restoration when the definition file that
the mistake is found in the content of the definition exists. Do not place the prototype definition file
in the following directories when backing up.
Windows®: C:\INTERSTAGE\ESWIN\etc\def
Solaris OE /Linux: /opt/FJSVes/etc/def
Example
Event Service resources are backed up to the "X:\Backup\ES" directory.
esbackupsys
-d
X:\Backup
Event Service resources are backed up to the "/backup/FJSVes" directory.
esbackupsys
22-4
-d
/backup
esrestoresys
esrestoresys
Name
esrestoresys
Restore and import of resources for the Event Service
Synopsis
esrestoresys
-d directory [-v3]
[-e]
[-M system]
Description
This command restores and imports Event Service resources backed up/exported by the esbackupsys
command.
The following explains the arguments for this command.
-d directory
Specify the storage directory name (full pathname) of Event Service resources with up to 1024 bytes.
Specify the directory name specified by the esbackupsys command.
-v3
Restores Event Service resources of the Interstage V3 environment backed up by using the esbackup
command (provided in the Interstage V3 environment).
-e
Specify -e to restore Event Service resources of the Interstage Application Server Standard Edition.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with administrator authority.
•
Stop the Event Service before restoring.
•
Restore CORBA Service resources beforehand.
22-5
Chapter 22: Backup Commands
•
If the Interstage V5 is installed on a machine on which the Interstage Application Server Standard
Edition V3 is installed by overwriting it, this command must be executed by specifying this option
only after the installation.
esrestoresys –e
Examples
Backup resources of the Event Service are restored.
esrestoresys
-d
X:\Backup
esrestoresys
-d
/backup
Event Service resources backed up in Interstage Application Server Enterprise Edition V3 are restored.
esrestoresys
-d
X:\Backup
esrestoresys
-d
/backup
-v3
-v3
Event Service resources backed up in Interstage Application Server Standard Edition V3 are restored.
22-6
esrestoresys
-d
X:\Backup
esrestoresys
-d
/backup
-v3
-v3
-e
-e
ijsbackup
ijsbackup
Name
ijsbackup
Backup and export of IJServer resources.
Synopsis
ijsbackup -d directory
Description
The ijsbackup command backs up and exports IJServer resources.
The following explains the arguments for this command:
-d directory
Specify the absolute path of the directory where the resources are going to be backed up.
It is necessary to create the specified directory before execution of this command. An error message
appears when a directory does not exist, or when the path does not lead to a directory.
Backup resources
The resources of the IJServer to be backed up are shown below.
•
Environment definition file under [J2EE common directory]\ijserver\[IJServer name] directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\webapps directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\ejbapps directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\client directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\common directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\distribute directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\soapgw directory
•
Data under [J2EE common directory]\ijserver\[IJServer name]\ext directory
•
Data under C:\Interstage\F3FMjs4\conf directory
•
C:\Interstage\F3FMihs\conf\workers2.properties
22-7
Chapter 22: Backup Commands
•
Environment definition file under /var/opt/FJSVj2ee/deployment/ijserver/[IJServer name] directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/webapps directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/ejbapps directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/client directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/common directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/distribute directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/soapgw directory
•
Data under /var/opt/FJSVj2ee/deployment/ijserver/[IJServername]/ext directory
•
Data under /etc/opt/FJSVjs4/conf directory
•
/etc/opt/FJSVihs/conf/workers2.properties
•
This command requires Administrator authority.
•
Execute this command while the Interstage is stopped.
•
Before executing this command, it is necessary to back up the Interstage setup resources, the
Component Transaction Service resources, the CORBA Service resources and the J2EE Common
resources.
Notes
Example
Save the IJServer resources in the directory "X:\backup":
C:\Interstage\J2EE\bin\ijsbackup -d X:\Backup
Save the IJServer resources in the directory "/backup":
/opt/FJSVj2ee/bin/ijsbackup -d /backup
22-8
ijsrestore
ijsrestore
Name
ijsrestore
Restore and import of the IJServer resources.
Synopsis
ijsrestore -d directory
Description
The ijsrestore command restores and imports IJServer resources.
If IJServer resources already exist, it is overwritten.
The following explains the arguments for this command:
-d directory
Specify the absolute path of the directory where the resources are going to be backed up.
It is necessary to create the specified directory before execution of this command. An error message
appears when a directory does not exist, or when the path does not lead to a directory.
Notes
•
Execute this command with Administrator authority.
•
Execute this command while the Interstage is stopped.
•
Before executing this command, it is necessary to back up the Interstage setup resources, the
Component Transaction Service resources, the CORBA Service resources and the J2EE Common
resources.
•
This command must be executed under the environment where Interstage is installed in the same
directory as that when the ijsbackup command is executed.
22-9
Chapter 22: Backup Commands
Example
To restore the IJServer resources from the directory "X:\backup":
C:\Interstage\J2EE\bin\ijsrestore -d X:\Backup
To restore the IJServer resources from the directory "/backup":
/opt/FJSVj2ee/bin/ijsrestore -d /backup
22-10
ippbackup
ippbackup
Name
ippbackup
Backup and export of resources for InfoProvider Pro
Synopsis
ippbackup -f config_file -d directory_name [-t all]
Description
The ippbackup command performs backup and export of resources for InfoProvider Pro.
This command is stored in the following directory.
C:\Interstage\F3FMwww\Program
/opt/FSUNprovd/bin
The options and arguments of the ippbackup command are explained below.
-f config_file
Specify the filename of the environment definition file that is the target of backup.
Specify the filename of the environment definition file that is the target of backup with the absolute
path.
22-11
Chapter 22: Backup Commands
-d directory_name
Specify the directory where the resources are going to be backed up with the absolute path.
The following directory is created under the specified directory and the InfoProvider Pro resources are
backed up under the following directory.
If backup processing ends abnormally and the following directory already exists, delete the following
directory and any subordinate directories.
F3FMwww
FSUNprovd
-t all
Specify the type of resources to be backed up.
When this option is specified, the environment definition file and the contents are the target of backup.
If this option is omitted, only the environment definition file is the target of backup.
For details of the resources to backup, refer to Maintenance (Resource Backup) in the Interstage
Operator's Guide.
Notes
22-12
•
Execute this command with Administrator authority.
•
Be sure to stop InfoProvider Pro when executing this command.
•
The root directory (/) cannot be specified to be the directory of a backup place.
ipprestore
ipprestore
Name
ipprestore
Restore and import of resources for InfoProvider Pro
Synopsis
ipprestore -d directory_name [-t all] [-v V31] [-x {safe|force}] [-l
infofile_name]
Description
The ipprestore command performs restore and import of resources for InfoProvider Pro.
This command is stored in the following directory.
C:\Interstage\F3FMwww\Program
/opt/FSUNprovd/bin
The options and arguments of the ipprestore command are explained below.
-d directory_name
Specify the source directory (the directory that was backed up with the ippbackup command) to restore
the resources, with the absolute path.
-t all
Specify the type of resources to restore.
When this option is specified, the environment definition file and the contents are the target of restore. In
order to specify this option, the -t all option must have been specified before using the ippbackup
command.
If this option is omitted, only the environment definition file is the target of restore.
For details of the resources to restore, refer to Maintenance (Resource Backup) in the Interstage
Operator's Guide.
-v V31
Specify -v V31 to restore/import resources backed up in the Interstage V3 environment.
22-13
Chapter 22: Backup Commands
-x {safe|force}
Specifies the processing format to be used when an executable file is restored/imported.
If the executable files that already exist are not restored/imported, specify safe.
If the executable files that already exist are also restored/imported, specify force.
If this option is omitted, safe is assumed to be specified.
An executable file indicates a file with one of the following extensions:
−
exe
−
dll
−
bat
−
com
−
cmd
-l infofile_name
Specifies the name of the file (overwrite information file) that the target files are output to if the
executable files are not restored/imported because -x safe is specified. Note that the contents of the file
are deleted if a file name that already exists is specified. If omitted, the target file names are output to
the standard output.
If you want to restore/import the files that were not restored/imported, delete the target files from the
environment, then re-execute the ipprestore command, specifying -x safe.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop InfoProvider Pro when executing this command.
•
When a file has already existed in the destination of restore, it is overwritten.
•
The disk configuration of the machine to which the resources are restored and imported, must have
the same disk configuration as the machine from which the resources are backed up and exported.
•
When the environment, which is backed by specifying the -t all option, is restored while omitting the
-t all option, all directories (including directories of the contents) are restored.
•
When the resources are imported to another machine, and when the following items are specified
in the Web server environment definition file, the set up values must be corrected to suit to the
importing machine by the use of an editor.
−
−
machine name (definition name:hostname)
IP address (definition name:IP-address)When -x force is specified, if the environment where
backup/export was performed and the environment where restoration/import is to be
performed are different, inconsistencies may occur due to application version differences.
If the environment including the Servlet Service definition was saved in the previous version of
Interstage, and restoration was performed in the current version of Interstage, for instance, the
Servlet Service of the previous version would be copied to the environment of the current version,
causing inconsistencies.
If the application environments are different, specify -x safe.
22-14
irdelete
irdelete
Name
irdelete
Deletes the Interface Repository database.
Synopsis
irdelete [-M system]
Description
This command deletes the Interface Repository database used for the Interface Repository to update
resource management information.
This command deletes the following files:
(Default installation path)
C:\INTERSTAGE\td\var\IRDB\irobf.qfl
C:\INTERSTAGE\td\var\IRDB\irobf.qfp
C:\INTERSTAGE\td\var\IRDB\irobftran
(When setting it up by the use of the isinit command. It is stored in the "C:\INTERSTAGE
\ODWIN\IRDB" during setup by the use of the odadmin_ex command.)
(Default installation path)
/opt/FSUNtd/var/IRDB/irobf.qfl
/opt/FSUNtd/var/IRDB/irobf.qfp
/opt/FSUNtd/var/IRDB/irobftran
(When setting it up by the use of the isinit command. It is stored in the "/opt/FSUNod/IRDB" during
setup by the use of the odadmin command.)
/opt/FJSVtd/var/IRDB/irobf.qfl
/opt/FJSVtd/var/IRDB/irobf.qfp
/opt/FJSVtd/var/IRDB/irobftran
(When setting it up by the use of the isinit command. It is stored in the "/opt/FJSVod/IRDB" during
setup by the use of the odadmin command.)
22-15
Chapter 22: Backup Commands
The following explains the arguments for this command.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
Specify the following directory for environment variable OD_HOME when this command is executed:
Windows®: C:\INTERSTAGE\ODWIN
Solaris OE: /opt/FSUNod
Linux: /opt/FJSVod
Messages
The following messages can be displayed at command execution:
No existing environment variable:OD_HOME
The environment variable “OD_HOME” has not been set.
No existing database file
Database could not be found.
Error:ObjectFile Delete error
Database deletion failed. The command was not executed under administrator authority.
22-16
iscbackupsys
iscbackupsys
Name
iscbackupsys
Backs up and export the Interstage setup resources.
Synopsis
iscbackupsys [-M system] backupdir
Description
The iscbackupsys command backs up and exports the Interstage initialization resources by using the
Interstage integrated command or the Interstage application operation tool.
The argument of the iscbackupsys command is explained below.
-M system
Specify the system name.
backupdir
Specify the storage directory for backup resources.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Allocate the necessary disk space to store the backup resources in the backup directory. Refer to
the Tuning Guide for information on the method of estimating the necessary amount of disk space
required to store the backup resources.
•
If a file or a directory having the name "isc" exists in the storage directory of the backup resource,
the backup processing results in an error.
22-17
Chapter 22: Backup Commands
Example
iscbackupsys X:\Backup
iscbackupsys /backup
22-18
iscrestoresys
iscrestoresys
Name
iscrestoresys
Restores and imports Interstage setup resources
Synopsis
iscrestoresys [-M system] {[-h hostname] | [-f restore-file]} backupdir
Description
The iscrestoresys command restores and imports Interstage initialization resources by using the
Interstage integrated command or the Interstage application operation tool.
The options and arguments of the iscrestoresys command are explained below.
Note that the -h option and -f option cannot be specified simultaneously.
-M system
Specify the system name.
-h hostname
Specify the name of the host used for the CORBA communication at the import destination server.
In the following condition, this option cannot be omitted.
•
Importing to or exporting from the same system of another server
-f restore-file
Specify the restore definition file.
This option can be used to import the exporting resources to another system of the same or different
server.
When importing Interstage setup resources, the definition items of the Interstage operation environment
definition as shown below can be customized by using the restore definition file.
•
Corba Host Name (Host name operating the CORBA Service)
•
Corba Port Number (Port number used for CORBA communication)
•
IR Path for DB file (Directory creating the database used in the Interface Repository)
22-19
Chapter 22: Backup Commands
•
TD path for system (Directory creating the operation environment of the Component Transaction
Service)
•
InfoProviderPro Definition (Environmental definition file and identifier of Web server)
For the definition items to be changed out of the above items, create a restore definition file in which the
definition information after change is described and specify the file with -f option of the iscrestoresys
command. The method for describing the restore definition file is the same as that for the Interstage
operation environment definition.
backupdir
Specify the storage directory of backup resources.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access files under the Interstage install directory during the execution of this command.
Example
iscrestoresys -h host1 X:\Backup
iscrestoresys -f restfile /backup
iscrestoresys -h host1 /backup
22-20
isguibackup
isguibackup
Name
isguibackup
Backup and export of Interstage application operation tool.
Synopsis
isguibackup isdir backupdir
Description
The isguibackup command performs backup and export of Interstage application operation tool
resources.
The arguments of the isguibackup backup command are described below.
isdir
Specify the Interstage install directory.
backupdir
Specify the backup resources storage directory.
Messages
The messages that are displayed during execution of this command are explained as follows.
isguibackup: INFO: Backup process finished.
Execution of this command has ended.
If any message is already output before this message is output, execution of this command has
failed. In such a case, re-execute this command by referring to the contents of the output message
and notes accompanying this command.
isguibackup: ERROR: Invalid parameter.
The specified parameter is invalid.
isguibackup: ERROR: INTERSTAGE was started.
Interstage has been started up. Stop Interstage.
22-21
Chapter 22: Backup Commands
isguibackup: ERROR: There is no permission to execute the command.
The user does not belong to the administrator local group. Execute this command from the user that
belongs to the administrator local group.
isguibackup: ERROR: %s does not exist.
The install directory %s of Interstage that is specified with the parameter of the command does not exist.
isguibackup: ERROR: %s already exists.
The storage directory %s of Interstage that is specified with the parameter of the command already
exists.
isguibackup: ERROR: Backup data already exist.
The backup resources already exist in the storage directory of backup resources that is specified with
the parameter of the command.
isguibackup: ERROR: A required file does not exist.
Backup resources do not exist. There is an error in specifying the install directory of Interstage.
isguibackup: ERROR: %s is not installed.
The package %s is not installed. It is necessary to install the package %s to back up the resources.
isguibackup: ERROR: Backup process failed.
The command has ended abnormally. Refer to the notes issued when this command was executed,
and check if there were any errors in the execution method. If there were any errors in the execution
method, execute the command again according to the notes. Otherwise see the error information
showing the causes of the errors of the command which is output at the end of the following file and
process the errors accordingly.
/var/opt/FSUNtd/trc/backup_restore/backup_error.log
Notes
22-22
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Allocate the necessary disk space to store the backup resources in the backup directory. Refer to
the Tuning Guide for information on the method of estimating the necessary amount of disk space
required to store the backup resources.
isguibackup
Example
isguibackup C:\INTERSTAGE
X:\Backup\isgui
isguibackup /backup/isgui
22-23
Chapter 22: Backup Commands
isguirestore
Name
isguirestore
Restore and import of the resources of Interstage application operation tool.
Synopsis
isguirestore isdir backupdir mode1 | mode2 | mode3
Description
The isguirestore command performs restore and import of the resources of the Interstage application
operation tool.
The arguments of the isguirestore command are explained below.
isdir
Specify the Interstage install directory.
backupdir
Specify the backup resources storage directory.
mode1 | mode2 | mode3
Specify the mode of restore and import of the resources. There are three modes as follows.
22-24
•
mode1
Specify this mode when the following conditions are met.
−
Restore the resources in the same server as that used to back up the resources.
−
Restore to the environment where initialization of the Interstage environment has been
completed.
•
mode2
Specify this mode when the following conditions are met.
−
Restore the resources in the same server as that used to backup the resources.
−
After re-installation of the Interstage, restore the resources to the environment that has not
been initialized yet.
isguirestore
•
mode3
Specify this mode when resources are exported to the server that is different from the server in
which the resources are backed up.
Messages
The meaning of the messages that are displayed during execution of this command is explained as
follows.
isguirestore: INFO: Restore process finished.
Execution of this command has ended.
If any message has already been output before this message is output, execution of this command
has failed. In such a case, re-execute this command by referring to the contents of the output
message and notes accompanying this command.
isguirestore: ERROR: Invalid parameter.
The specified parameter is invalid.
isguirestore: ERROR: INTERSTAGE was started.
Interstage has already been started up. Stop Interstage.
isguirestore: ERROR: There is no permission to execute the command.
The user does not belong to the administrator local group. Execute this command from the user that
belongs to the administrator local group.
isguirestore: ERROR: %s does not exist.
The Interstage install directory that is specified with the parameter of the command or the storage
directory %s of the backup resources do not exist.
isguirestore: ERROR: A required file does not exist.
Backup resources do not exist. There is an error in specifying the backup resource storage directory, or
the resource backup work has not been executed correctly.
isguirestore: ERROR: %s is not installed.
The package %s is not installed. It is necessary to install the package %s to back up the resources.
isguirestore: ERROR: Backup process failed.
The command has ended abnormally. Refer to the notes issued when this command was executed,
and check if there were any errors in the execution method. If there were any errors in the execution
method, execute the command again according to the notes. Otherwise see the error information
showing the causes of errors for the command which is output at the end of the following file and
process the errors accordingly.
/var/opt/FSUNtd/trc/backup_restore/backup_error.log
22-25
Chapter 22: Backup Commands
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access the files under the Interstage install directory during execution of this command.
Example
isguirestore C:\INTERSTAGE X:\Backup\isgui mode1
isguirestore /backup/isgui
22-26
issoapbackup
issoapbackup
Name
issoapbackup
Backs up and exports Interstage SOAP Service resources.
Synopsis
issoapbackup
-d Directory [ path1 ][ path2 ] ...
issoapbackup
[-M system_name] -d Directory [ path1 ][ path2 ] ...
Description
The issoapbackup command backs up Interstage SOAP Service resources under the following
directories under the directory indicated by Directory.
•
"C:\Interstage\F3FMsoap\etc” directory
•
"C:\Interstage\F3FMsoap\conf" directory
•
"/etc/opt/FJSVsoap/etc" directory
•
"/etc/opt/FJSVsoap/conf" directory
Resources of the Interstage SOAP Service that were backed up are stored in the same directory
structure as that before backup under the directory indicated by Directory.
-d Directory
Specify the directory with the absolute path name of the backup destination of the Interstage SOAP
Service resources.
-M system_name
Specify the name of the system whose resources are to be backed up.
If this option is omitted, Interstage SOAP Service resources are backed up from the system specified in
the environment variable IS_SYSTEM.
22-27
Chapter 22: Backup Commands
Interstage SOAP Service resources are backed up from the default system in the following cases:
•
If the default is set to system_name
•
If this option is omitted and the default is set to the environment variable IS_SYSTEM
•
If this option is omitted and the environment variable IS_SYSTEM does not exist
[ path1 ][ path2 ] ...
When backing up the Interstage SOAP Service resources that are not located under the directory
backed up with the default value, specify the directory name or the file name with the full path. If the
directory name is specified, all the files under the directory are backed up.
Specify the parameters when a Web service information management file, security environment settings,
or other files are created in any other directory than the one backed up by default.
Messages
The results of the command are displayed on the command execution screen. For the contents of the
messages, refer to "Messages of Diagnosis/Maintenance Commands" in the Messages.
Notes
22-28
•
Before executing this command, stop the Servlet container in which the Interstage SOAP Service is
running or the Servlet Service with the Servlet Service operating command.
•
Only an administrator can use this command.
•
Before executing this command, create a directory for backing up Interstage SOAP Service
resources.
•
If the directory indicated by Directory does not exist, and if it is not a directory, an error is issued in
both cases.
•
Specify Directory with the absolute path.
•
If a file or a directory exists under the directory that is indicated by Directory, an error is issued.
•
If an attempt to back up resources fails for some reason, all the files under the Directory are
deleted.
issoaprestore
issoaprestore
Name
issoaprestore
Restores and imports Interstage SOAP Service resources.
Synopsis
issoaprestore [-a drive] –d Directory
issoaprestore [ -M system_name ] [-a] –d Directory
issoaprestore [-a] –d Directory
Description
The issoaprestore command restores Interstage SOAP Service resources from the directory indicated
by Directory to the Interstage SOAP Service operating environment.
If Interstage SOAP Service resources exist, they are overwritten.
-d Directory
Specify the name of the directory in which resources of the Interstage SOAP Service are backed up.
-a drive
Restores resources of the Interstage SOAP Service backed up using "path1, path2 ..." as specified for
the issoapbackup command with the same pathname as that used for backup under "drive".
Specify this option if there is any resource of the Interstage SOAP Service backed up using "path1,
path2 ..." as specified for the issoapbackup command.
If this option is omitted, only resources of the Interstage SOAP Service that have been backed up
according to the default value of the issoapbackup command are restored to the operation environment
of the Interstage SOAP Service.
22-29
Chapter 22: Backup Commands
-M system_name
Specify the name of the system whose resources are to be restored.
If this option is omitted, Interstage SOAP Service resources are restored to the system specified in the
environment variable IS_SYSTEM.
Interstage SOAP Service resources are restored from the default system in the following cases:
•
If the default is set to system_name
•
If this option is omitted and the default is set to the environment variable IS_SYSTEM
•
If this option is omitted and the environment variable IS_SYSTEM does not exist
-a
Restores resources of the Interstage SOAP Service backed up using "path1, path2 ..." as specified for
the issoapbackup command with the same pathname as that used for backup.
Specify this option if there is any resource of the Interstage SOAP Service backed up using "path1,
path2 ..." as specified for the issoapbackup command.
If this option is omitted, only resources of the Interstage SOAP Service that have been backed up by the
default value of the issoapbackup command are restored to the operation environment of the Interstage
SOAP Service.
Messages
The results of the command are displayed on the command execution screen. For the contents of the
messages, refer to "Messages of Diagnosis/Maintenance Commands" in the Messages.
Notes
22-30
•
Before executing this command, stop the Servlet container in which the Interstage SOAP Service is
running or the Servlet Service with the Servlet Service operating command.
•
Only an administrator can use this command.
•
Before executing this command, check that resources of the Servlet Service and the Interstage
SOAP Service are backed up.
•
If the directory that is indicated by Directory does not exist, and if it is not a directory, an error is
issued in both cases.
•
Specify Directory with the absolute path.
•
Execute this command in an environment in which the Interstage Application Server is installed in
the same directory as that in which issoapbackup is executed.
•
When a file exists in the restore destination, it is overwritten.
•
In case the backed up resource is a symbolic link, it may be restored not as a symbolic link but as a
solid file described in the environment configuration file.
j2eebackup
j2eebackup
Name
j2eebackup
Backs up and exports the common J2EE resources.
Synopsis
j2eebackup –d backupdir [-M system]
Description
The j2eebackup command backs up and exports the common J2EE resources. This command backs
up the files under the directory specified by backupdir.
The argument of the j2eebackup command is as follows:
-d backupdir
Specify the storage directory for backup resources.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Messages
The execution results of the command are displayed on the command execution screen. For the
contents of the messages, refer to "Messages with Message Number beginning isj2ee" in the Messages.
Notes
•
The j2eebackup command should confirm that the directory in which the jar command is stored is
included in the environment variable PATH because the jar command is used for internal
processing.
22-31
Chapter 22: Backup Commands
j2eerestore
Name
j2eerestore
Restores and imports the common J2EE resources.
Synopsis
j2eerestore –d backupdir [-M system]
Description
The j2eerestore command restores and imports the common J2EE resources.
The argument of the j2eerestore command is as follows:
-d backupdir
Specify the storage directory of backup resources.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Messages
The execution results of the command are displayed on the command execution screen. For the
contents of the messages, refer to "Messages with Message Number beginning isj2ee" in the Messages.
Notes
•
22-32
The j2eerestore command should confirm that the directory in which the jar command is stored is
included in the environment variable PATH because the jar command is used for internal
processing.
jmsbackup
jmsbackup
Name
jmsbackup
Backs up and exports the Interstage JMS resources.
Synopsis
jmsbackup -d <backup-directory> [-M system]
Description
The jmsbackup command backs up and exports the Interstage JMS resources.
The option and parameter of this command are shown below.
-d <backup-directory>
Specify the directory in which the resource files are stored.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
Nonexistence of the specified directory results in an error.
•
Ensure that the JMS application is in stop state before executing this command.
22-33
Chapter 22: Backup Commands
Example
To save the environment definition in the directory "D:\backup":
jmsbackup -d D:\backup
To save the environment definition in the directory "/backup":
jmsbackup -d /backup
22-34
jmsrestore
jmsrestore
Name
jmsrestore
Restores and imports the Interstage JMS resources.
Synopsis
jmsrestore -d <backup-directory> [-all] [-M system]
Description
The jmsrestore command restores/imports Interstage JMS resource files backed up/exported by the
jmsbackup command.
The options and parameter of this command are shown below.
-d <backup-directory>
Specify the directory in which the resource files are stored.
-all
With this option specified, all resources (JMS definition information and JMS nonvolatile information) are
restored.
When this option is omitted, only JMS definition information is restored.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority for Solaris OE and Linux systems.
•
The -all option should be specified when the Event Service (notification service) environment is not
recreated.
•
Confirm that the JMS application is in stop state before executing this command.
22-35
Chapter 22: Backup Commands
Example
To restore the environment definitions from the directory "D:\backup" (at recreation of Event Service):
jmsrestore –d D:\backup
To restore the environment definitions from the directory "/backup" (at recreation of Event Service):
jmsrestore –d /backup
22-36
obfbkup
obfbkup
Name
obfbkup
Backs up the Interface Repository database.
Synopsis
obfbkup
backupdir
[-M system]
Description
This command backs up the database used for the Interface Repository.
This command backs up the following files:
(Default installation path)
C:\INTERSTAGE\td\var\IRDB\irobf.qfl
C:\INTERSTAGE\td\var\IRDB\irobf.qfp
C:\INTERSTAGE\td\var\IRDB\irobftran
(When setting it up using the isinit command. It is stored in "C:\INTERSTAGE \ODWIN\IRDB"
during setup using the odadmin_ex command.)
(Default installation path)
/opt/FSUNtd/var/IRDB/irobf.qfl
/opt/FSUNtd/var/IRDB/irobf.qfp
/opt/FSUNtd/var/IRDB/irobftran
(When setting it up using the isinit command. It is stored in "/opt/FSUNod/IRDB" during setup using
the odadmin command.)
/opt/FJSVtd/var/IRDB/irobf.qfl
/opt/FJSVtd/var/IRDB/irobf.qfp
/opt/FJSVtd/var/IRDB/irobftran
(When setting it up using the isinit command. It is stored in "/opt/FJSVod/IRDB" during setup using
the odadmin command.)
Use the obfrestore command to restore backed up files.
Invoke the obfbkup command under administrator authority of database.
The arguments of this command are as follows:
backupdir
This parameter specifies the backup directory.
22-37
Chapter 22: Backup Commands
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
Specify the following directory for environment variable OD_HOME when this command is executed:
Windows®: C:\INTERSTAGE\ODWIN
Solaris OE: /opt/FSUNod
Linux: /opt/FJSVod
Messages
The following messages can be displayed at command execution:
No exist environment variable.
The environment variable “OD_HOME” could not be found. Set the environment variable “OD_HOME”.
Illegal command line
The specified parameter in the command is incorrect. Specify the correct parameter.
No exist database file.
Interface repository database file could not be found.
Can not execute command.
Failed to execute the command.
Can not execute command. -- Database Broken –
Failed to execute the command. The database may be broken.
Disk full.
The available free disk space is insufficient. Secure free disk space.
22-38
obfrestore
obfrestore
Name
obfrestore
Restores the database.
Synopsis
obfrestore
backupdir
datadir
Description
This command restores the database used for the Interface Repository. This command restores files
backed up with the obfbkup command.
The arguments of this command are as follows:
backupdir
This parameter specifies the backup directory.
Specify the backup directory used when the obfbkup command was executed.
datadir
This parameter specifies the database storage destination directory.
To restore database files backed up with the obfbkup command, specify the database storage directory
used when the obfbkup command was executed.
Notes
If the file has been restored to a directory other than the storage destination directory when obfbkup was
executed, edit the following items after restoring the Interface Repository environment file:
C:\INTERSTAGE\ODWIN\etc\irpth
objectfile create path = "Database storage destination directory"
/opt/FSUNod/etc/irpth
objectfile create path = "Database storage destination directory"
/opt/FJSVod/etc/irpth
objectfile create path = "Database storage destination directory"
In "Database storage destination directory", specify the directory in which the restored database is to be
stored.
22-39
Chapter 22: Backup Commands
Messages
The following messages can be displayed at command execution:
Illegal parameter: backupdir
The backup directory could not be found. Specify the correct backup directory.
No exist database file.
Interface repository database file could not be found. Check that the interface repository database file
exists in the backup directory.
Can not execute command.
Failed to execute the command.
Disk full.
The available free disk space is insufficient. Secure free disk space.
Illegal parameter: datadir.
Database storage location directory could not be found.
22-40
odbackupsys
odbackupsys
Name
odbackupsys
Backup/Export of CORBA Service resource files.
Synopsis
odbackupsys
backupdir
[-M system]
Description
This command backs up and exports resources files used by the CORBA Service. CORBA Service
resource files include CORBA Service (ORB) resources, Naming Service resources, load balance
resources, and interface repository resources.
The following explains the argument for this command.
backupdir
Specify the storage directory of CORBA Service resources to be backed up/exported. The following
directory is created under the specified directory and CORBA Service resources are backed up under
the following directory. If the following directory already exists, delete the directory.
Windows®: OD
Solaris OE: FSUNod
Linux: FJSVod
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access CORBA Service resources while executing this command.
•
If 129 load balance object groups or more are registered, it is not possible to back up/export all
object groups. In that case, all information can be backed up or exported by editing the operation
environment file (nsconfig) of the Naming Service. For details of the operation environment file
(nsconfig) of the Naming Service, refer to nsconfig in the Tuning Guide.
22-41
Chapter 22: Backup Commands
odexportir
Name
odexportir
Exports interface information.
Synopsis
odexportir
[-e] [-r RepositoryId[,..]] filename
[-M system]
Description
The odexportir command extracts the interface object contained in the specified module or interface,
from the Interface Repository, and generates an interface definition information registration file (referred
to below as an interface information file).
The interface definition information stored in the interface information file generated using this command
can be registered with the Interface Repository on another server by using the odimportdir command.
-e
Specify when value interface is being used in the Interface Repository to be exported. When this option
isn't specified, it is exported as the Interface Repository of the standard interface.
This option needs that value interface must be specified when setting up of the Interface Repository.
-r RepositoryId
Specify the module to be exported and the repository ID of the interface. If more than one is to be
exported, delimit the characters with commas. If this option is not specified, it is assumed that all the
objects registered in the Interface Repository are to be exported.
filename
Specify the name of the interface information file. If another file with the same name already exists, the
command will terminate abnormally.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
22-42
odexportir
Notes
•
The Interface Repository needs to be started before the export command is executed.
•
When extracting part of an interface, if the specified interface inherits a different interface, the
inheriting interface or the object containing the inheriting interface should also be specified for
export. Also, if an object from a hierarchical level other than the highest level has been partially
extracted, a new object for the object extracted to the import destination will be required. This
should not be used unless the object is to be overwritten.
An example is shown below.
Module test1 {
// module declaration
Interface intf1 {
// interface declaration
Long add (in long a, in long b); // operation declaration.
};
}
In the example above, when the interface “intf1” is partially extracted, the module “test1” is needed
at the import destination.
•
If exporting from an Interface Repository of a different version of the CORBA Service
(ObjectDirector) (when using the Interface Repository of a remote server), information cannot be
exported from the later version on the local server.
Moreover, even if the versions are the same, export may not be possible between different systems.
•
When you want to execute the export command, the time zone must be set in the TZ environment
variables.
TZ = "JST-9"
If the above setting is not performed, the export time information of the created interface
information file may not be set correctly.
22-43
Chapter 22: Backup Commands
Messages
The meanings of the messages displayed when the command is started are as follows:
Error: File already exists.
A file with the same name already exists.
Error: RepositoryId is not found.
The object to be exported does not exist.
Error: DefinitionKind of RepositoryId is wrong. Please specify Interface or Module
The object to be exported is of the wrong type. Specify the interface or module.
Error: Insufficient memory available (n)
Failed to obtain enough memory. System error number: n
Error: File open error (n)
Failed to generate file. System error number: n
Error: File write error (n)
Failed to write to file. System error number: n
Error: CDR error (n)
Failed to encode data. Error number: n
Error gen (Error function name)
SYSTEM Exception Raised : Error information
An error was detected in the function of the CORBA Service.
For the meaning of error information, refer to Exception Information Minor Codes to be Reported from
the CORBA Service in the Messages.
Error:Library load error.
An attempt to load the library failed.
The library file may be deleted. Re-install the library.
22-44
odexportns
odexportns
Name
odexportns
Exports Naming Service registration information.
Synopsis
odexportns
-o
filename
[-M system]
Description
This command exports registration information of object references managed by the Naming Service
and load balance option.
When this command is executed, a filename file is created. This file is needed when information is
exported using the odimportns command.
Also, a filename_list file is created in which the registration information list of exported object references
is stored.
The following shows the specifiable parameters:
-o filename
Stores registration information of object references managed by the Naming Service and load balance
option in the file specified by filename. Also the registration information list is stored in filename_list.
The following shows how to view the registration information list (filename_list).
cnauto::intf(o) IDL:cnauto/intf:1.0, IDL:cnauto/intf:1.0,
(r2d2:8002:1.1:NONE:ON)
(a)
(b)
(c)
(d)
(h) (i)
a)
Name registered with the Naming Service
b)
Registered type
c)
Interface repository ID
d)
Implementation repository ID
e)
Object host name
f)
Object port number
g)
Object version
h)
Code system
i)
SSL information
(e)
(f)
(g)
22-45
Chapter 22: Backup Commands
-M system
Specify the operation target system name “system” when an extended system is generated.. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
When executing this command, the Naming Service must be active. If the load balance option is
used, the load balance option must also be active.
•
If 129 load balance object groups or more are registered, it is not possible to export all object
groups. In that case, all information can be exported by editing the operation environment file
(nsconfig) of the Naming Service. For details of the operation environment file (nsconfig) of the
Naming Service, refer to nsconfig in the Tuning Guide.
Messages
The meanings of the messages displayed when the command is started are as follows:
NamingService is not registered in Service.
Because the Naming Service is not registered as an initial service, processing was stopped.
Register the Naming Service as an initial service, start the service, and re-execute the command.
LoadBalancingOption is not registered in Service.
Because the load balance option is not registered as an initial service, processing was stopped.
Register the load balance option as an initial service, start the service, and re-execute the command.
The specified file already exist. Error information (target file name)
Because the specified file already exists, the command could not be executed.
Delete the file, or specify a different file name and re-execute the command.
Failed to open file. Error information (target file name: detailed error information)
Because the file could not be opened, processing was stopped.
Refer to the detailed error information, take necessary action, and re-execute the command.
Failed to operate file. Error information (target file name: detailed error information)
Because the file manipulation failed, processing was stopped.
Refer to the detailed error information, take necessary action, and re-execute the command.
Memory allocation failed.
A memory shortage occurred.
Check whether sufficient memory is allocated.
Abnormality notified from ObjectDirector.
error: Name of the application interface where an error occurred
id: Detailed error information
Because an error was reported from the CORBA Service, processing was stopped.
22-46
odexportns
Refer to the detailed error information, take necessary action, and re-execute the command.
The following shows the meanings of detailed error information:
error:CORBA_ORB_init
id:IDL:CORBA/StExcep/UNKNOWN:1.0
The CORBA Service has not been started.
error:CosNaming_NamingContext_list
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The Naming Service has not been started.
error:ISOD_LBO_resolve_LBG
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The load balance option has not been started.
22-47
Chapter 22: Backup Commands
odimportir
Name
odimportir
Imports the interface information.
Synopsis
odimportir
[-e] [-a | -v | -i] filename
[-M system]
Description
The odimportir command uses the interface information file generated using the exportdir command to
import the interface information.
Before carrying out the import, by default, this command checks whether interface information with the
same name is present at the import destination. If interface information having the same repository ID is
present in the interface information file at the import destination, it reports an error.
-e
Specify when value interface is being used in the Interface Repository to be imported. When this option
isn't specified, it is imported as the Interface Repository of the standard interface.
This option needs that value interface must be specified when setting up of the Interface Repository,
and the interface information file must be generated from Interface Repository of value interface
invoking “odexportir -e”.
-a
Specify this option if you do not want the command to check the interface information at the import
destination when performing the import. If interface information having the same repository ID is present
in the interface information file at the import destination, it will be overwritten by the new interface
information to be imported.
-v
Specify this option if you do not want the command to check the interface information at the import
destination when performing the import. If interface information having the same repository ID is present
in the interface information file at the import destination, it will be overwritten by the new interface
information to be imported. The overwritten interface information will be displayed on the standard
output.
-i
Specify this option if you want to display the information for the interface information file.
filename
Specifies the name of the interface information file to be imported.
22-48
odimportir
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
The Interface Repository needs to be started before the import command is executed. A database
backup should also be carried out without fail, using the obfbkup command, before an import is
carried out.
•
If importing from an interface information file that was generated using information exported from
an Interface Repository of a different version of the CORBA Service (ObjectDirector), information
cannot be imported from the export address server to the earlier version.
In an environment that uses the Interface Repository of a remote server, information cannot be
imported if the version at the remote server is earlier than the version at the local server.
Even if the versions are the same, interface information files generated at different systems may
not be able to be imported.
Messages
The meanings of the messages displayed when this command is started are as follows:
Error: An invalid file was specified.
The file you have specified is not an interface information file.
Error: Object which has the same RepositoryID exists.
The same repository ID is already found at the import destination.
Error: Insufficient memory available. (n)
Failed to obtain memory. System error number: n
Error: Cannot execute command.
A contradiction with the export data has occurred. It is possible that the required inheriting interface has
not been specified.
Error: File open error (n)
Failed to open file. System error number: n
Error: File read error (n)
Failed to read file. System error number: n
Error: CDR error (n)
Failed to decode data. Error number: n
Error: The version of the file isn't correct.
The specified interface information file could not be imported. Check the CORBA Service version at the
export address and the option specifications.
22-49
Chapter 22: Backup Commands
Error gen (Error function name)
SYSTEM Exception Raised: Error information
An error was detected in the function of the CORBA Service.
For the meaning of error information, refer to Exception Information Minor Codes to be Reported from
the CORBA Service in the Messages.
Error:file status error(n)
An attempt to acquire a file status failed. System error number: n
Error:Can not execute command.
Error information
An attempt to execute the command failed due to the reason described in error details. Write down the
error information and contact the SE.
Error:Library load error.
An attempt to load the library failed.
The library file may be deleted. Re-install the library.
Example
odimportir –i filename
Time:
Fri Mar 26 08:01:20 1999
File V/L: 01/01
version */
IR V/L:
04/00
*/
File size: 000000000000b910
digits) */
OS:
SunOS 5.6
/* OS info for
executed */
IMPORT OBJECT INFORMATION
ID: IDL: ARRtest1:1.0
Name:
ARRtest1
VERSION: 1.0
/* import time (GMT) */
/* Interface information file
/* Interface Repository version
/* file size (16 hexadecimal
machine where export command
/*
/*
/*
/*
object information (title) */
Repository ID */
name */
version name */
Note
If a (full export) interface information file is generated without specifying the repository ID at the time of
export, the displayed object information will be the module or interface directly below root. If the
repository ID is specified at the time of export, the displayed object information will be the information for
the specified repository ID.
22-50
odimportns
odimportns
Name
odimportns
Imports Naming Service registration information.
Synopsis
odimportns
[-g]
-i filename
[-h Hostlistfile] [-M system]
Description
This command imports object reference information managed by the Naming Service and load balance
option.
If this command is executed, object references are registered with the Naming Service using a file
created by the odexportns command.
The following shows the specifiable parameters:
-g
Specify -g if the load balance option was used in the export environment. If this option is specified,
object groups managed by the load balance option are also imported.
-i filename
Imports the Naming Service. Specify the file created by the odexportns command in filename.
-h Hostlistfile
Changes the host name or port number of the object references during import. Specify a file containing
change information of the host names in Hostlistfile.
Enter the old host name before change to be described in the host name change information file in the
format (host name / host IP address) registered during export. The format of the old host name before
change can be checked by the filename_list file created by the odexportns command.
The following shows the coding format of the host name change information file.
[Coding format]
Old host name before change: port number new host name after change: port number
[Example]
fromhost1:8002 tohost1:8002
fromhost2:8002 tohost2:8003
fromhost3:8003 tohost3:8002
22-51
Chapter 22: Backup Commands
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
When executing this command, the Naming Service must be active. If the -g option is specified,
the load balance option must also be active.
•
If the same binding name is already registered, an error occurs.
•
If the naming contents were linked in the export environment, a naming context is created at the
local host instead of links when this command is executed.
Messages
The meanings of the messages displayed when this command is started are as follows:
NamingService is not registered in Service.
Because the Naming Service is not registered as an initial service, processing was stopped.
Register the Naming Service as an initial service, start the service, and re-execute the command.
LoadBalancingOption is not registered in Service.
Because the load balance option is not registered as an initial service, processing was stopped.
Register the load balance option as an initial service, start the service, and re-execute the command.
The specified file does not exist. Error information (target file name)
Because the specified file does not exist, the command could not be executed.
Specify the correct path and re-execute the command.
Failed to open file. Error information (target file name: detailed error information)
Because the file could not be opened, processing was stopped.
Refer to the detailed error information, take necessary action, and re-execute the command.
The specified file contains an error. Error information (target file name)
Because the file is incorrect, processing was stopped.
If the target file is a host conversion file, the coding format is not correct. Correct the file and re-execute
the command.
If the target file is an export resource, the resource may be damaged. Re-execute the export command
(odexportns), then re-execute odimportns using the correct resource.
Failed to operate file. Error information (target file name: detailed error information)
Because the file manipulation failed, processing was stopped.
Refer to the detailed error information, take necessary action, and re-execute the command.
22-52
odimportns
Memory allocation failed.
A memory shortage occurred.
Check whether sufficient memory is allocated.
The specified file contains an error or memory allocation failed. Error infomation(target file
name)
The file is incorrect or a memory shortage occurred.
Check whether any export resource is damaged.
If a resource is damaged, reexecute the export command (odexportns), then re-execute odimportns
using the correct resource.
If no resource is damaged, a memory shortage occurred. Check whether sufficient memory is allocated.
Failed to create Object Reference.
Because the creation of an object reference failed, processing was stopped.
A resource such as memory may be insufficient. Check resources and re-execute the command. If the
same error occurs again, contact your system administrator.
Failed to unregister Object Reference.
An attempt was made to delete a registered object reference after an error occurred during processing,
but the deletion failed.
Import was not carried out properly. Delete object references registered with the Naming Service,
review the environment, and re-execute the command.
Abnormality notified from ObjectDirector.
error: Name of the application interface where an error occurred
id: Detailed error information
Because an error was reported from the CORBA Service, processing was stopped.
Refer to the detailed error information, take necessary action, and re-execute the command.
The following shows the meanings of detailed error information:
error:CORBA_ORB_init
id:IDL:CORBA/StExcep/UNKNOWN:1.0
The CORBA Service has not been started.
error:CosNaming_NamingContext_bind
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
or
error:CosNaming_NamingContext_bind_new_context
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
or
error:ISOD_LBO_create_LBG
id:IDL:ISOD/LBO/CannotProceed:1.0
The Naming Service has not been started.
error:ISOD_LBO_create_LBG
id:IDL:CORBA/StExcep/NO_IMPLEMENT:1.0
The load balance option has not been started.
22-53
Chapter 22: Backup Commands
error:CosNaming_NamingContext_bind
id:IDL:CosNaming/NamingContext/AlreadyBound:1.0
or
error:CosNaming_NamingContext_bind_new_context
id:IDL:CosNaming/NamingContext/AlreadyBound:1.0
or
error:ISOD_LBO_create_LBG
id:IDL:ISOD/LBO/AlreadyExist:1.0
An object reference with the same binding name is already registered.
error:CosNaming_NamingContext_bind_new_context
id:IDL:CORBA/StExcep/IMP_LIMIT:1.0
The upper limit of the naming contexts that can be registered has been exceeded.
22-54
odrestoresys
odrestoresys
Name
odrestoresys
Restores/Imports CORBA Service resource files.
Synopsis
(1) Restoring of CORBA Service resource files
odrestoresys
-r
[-od]
[-ns]
[-ir]
backupdir
[-M system]
(2) Import of CORBA Service resource files
odrestoresys
system]
[-h hostname -p portnum]
[-irpath path]
backupdir
[-M
(3) Restoring of CORBA Service resource files
odrestoresys
-r
-v3
backupdir
[-M system]
Description
This command restores/imports CORBA Service resource files backed up/exported by the odbackupsys
command. CORBA Service resource files include CORBA Service (ORB) resources, Naming Service
resources, load balance resources, and interface repository resources.
"(1) Restoring of CORBA Service resource files" is used when restoring resource files on the same
machine. The host name and port number in the CORBA Service resource files are not changed.
"(2) Import of CORBA Service resource files" is used when restoring resource files on different
machines. The host name and port number in the CORBA Service resource files are changed.
"(3) Restoring of CORBA Service resource files in the Interstage V3 environment" is used to restore
resources of V3 or earlier to the V4 environment or later when upgrading the V3 environment or earlier
to the V4 environment or later.
The following explains the arguments for this command:
-h hostname
Imports resource files after changing the host name set in the CORBA Service resource files (files under
the config, initial_hosts/inithost, initial_services/init_svc, impl.db, and CosNaming directories) to the one
specified in hostname.
22-55
Chapter 22: Backup Commands
-p portnum
Imports resource files after changing the port number set in the CORBA Service resource files (files
under the config, initial_hosts/inithost, initial_services/init_svc, impl.db, and CosNaming directories) to
the one specified in portnum.
-irpath path
Imports a database in the interface repository service to the path specified by path.
Specify with the absolute path containing the drive name. It is a character string excluding control
characters (0x00 to0x1F and 0x7F of the ShiftJIS code). It is case insensitive for both en-size and
em-size letters. Up to 255 characters may be specified.
Set with character string excluding a blank character starting with a slash "/" and en-size kana
characters. The maximum length is the value of MAXPATHLEN in /usr/include/sys/param.h,
including NULL characters at the end.
-r
Restores resource files without changing information about CORBA Service resources. To restore
resources, specify normally this option.
-od
Restores CORBA Service (ORB) resources only.
-ns
Restores Naming Service resources only. If this option is not specified simultaneously with the -od
option, only Naming Service databases are restored.
-ir
Restores interface repository resources only. If this option is not specified simultaneously with the -od
option, only interface repository databases are restored.
-v3
Restores CORBA Service resources of the Interstage V3 environment backed up by using the odbkup,
irbkup, or obkbkup command (provided by the Interstage V3 environment).
backupdir
Specify the storage directory of CORBA Service resources. Specify the directory name specified in the
odbackupsys command. If this option is specified simultaneously with the -v3 option, specify the
directory specified in the odbkup, irbkup, or obfbkup command (provided by the Interstage V3
environment).
22-56
odrestoresys
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access CORBA Service resources while executing this command.
•
When one of the conditions is satisfied while the resources are imported, the IP-version value in the
config file may be changed.
−
−
−
−
•
The setting value at the import source is v6, but IPv6 is not supported at the import destination.
The setting value at the import source is v6, but an IP address of IPv4 is specified as a host
name.
The setting value at the import source is v4, but an IP address of IPv6 is specified as a host
name.
The setting value at the import source is v4, a name resolvable host name for IPv6 is specified.
When the IP-version value is changed, the message od16272 is output.
22-57
Chapter 22: Backup Commands
otsbackupsys
Name
otsbackupsys
Backup/Export of Database Linkage Service resources.
Synopsis
otsbackupsys
backupdir
Description
This command backs up and exports Database Linkage Service resources.
The following explains the argument for this command.
backupdir
Specify the storage directory for backup resources.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Allocate sufficient free disk space required to store backup resources in the storage directory of
backup resources. For the method to estimate the required capacity of disk to store backup
resources, refer to "Backup procedure" or "Resource export procedure" in "Maintenance (Resource
backup)" in the Operator's Guide.
•
Check that no backup copy of Database Linkage Service resources is made at the backup/export
destination.
•
If the backup resource storage path contains any blank character, the path must be encircled with "
" (double quotation mark) when specifying command parameters.
Example
otsbackupsys X:\Backup\
otsbackupsys /backup/
22-58
otsrestoresys
otsrestoresys
Name
otsrestoresys
Restores/Imports Database Linkage Service resources.
Synopsis
otsrestoresys
backupdir
Description
This command restores/imports Database Linkage Service resources.
The following explains the argument for this command:
backupdir
Specify the storage directory of restore resources.
Notes
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access files under the Interstage installation directory.
•
If the restore resource storage path contains any blank character, the path must be encircled with "
" (double quotation mark) when specifying command parameters.
Example
otsrestoresys
X:\Backup\
otsrestoresys
/backup/
22-59
Chapter 22: Backup Commands
tdbackupsys
Name
tdbackupsys
Backs up/Exports Component Transaction Service resources.
Synopsis
tdbackupsys
[-M sysname] backupdir
Description
This command backs up/exports Component Transaction Service resources.
The following explains the arguments for this command:
backupdir
Specify the storage directory of backup resources.
-M sysname
Specify the backs up/exports target system name “system” when an extended system is generated. If
this option is omitted, operation using the default system becomes the target.
Notes
22-60
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Reserve sufficient free disk space required for backup resource storage in the backup resource
storage directory. For the method to estimate the required capacity of disk to store backup
resources, refer to "Backup procedure" or "Resource export procedure" in "Maintenance (Resource
backup)" in the Operator's Guide.
•
Check that no backup copy of Component Transaction Service resources is made at the
backup/export destination.
•
If the backup resource storage path contains any blank character, the path must be encircled with "
" (double quotation mark) when specifying command parameters.
tdbackupsys
Example
tdbackupsys
X:\Backup\
tdbackupsys
/backup/
22-61
Chapter 22: Backup Commands
tdrestoresys
Name
tdrestoresys
Restores/Imports Component Transaction Service resources.
Synopsis
tdrestoresys
[-M sysname] backupdir
Description
This command restores/imports Component Transaction Service resources.
The following explains the argument for this command:
backupdir
Specify the storage directory of restore resources.
-M sysname
Specify the backs up/exports target system name “system” when an extended system is generated. If
this option is omitted, operation using the default system becomes the target.
Notes
22-62
•
Execute this command with Administrator authority.
•
Be sure to stop Interstage before executing this command.
•
Do not access files under the Interstage installation directory.
•
If the restore resource storage path contains any blank character, the path must be encircled with "
" (double quotation mark) when specifying command parameters.
tdrestoresys
Example
tdrestoresys
X:\Backup\
tdrestoresys
/backup/
22-63
Chapter 22: Backup Commands
22-64
Chapter 23
Maintenance Commands
This chapter details the Maintenance commands.
Note
Maintenance information collection commands other than the iscollectinfo command can be used with
the products listed below:
•
Interstage Application Server Enterprise Edition
•
Interstage Application Server Standard Edition
•
Interstage Application Server Plus
In the Plus Edition, only the following commands can be used:
−
esdump
−
eslogdump
−
irlogdump
−
odcvttrace
−
odformsnap
−
odformtrace
−
odfreesnap
−
odprtcurparam
−
odprthdrtrace
−
odstartsnap
−
odstopsnap
−
otsgetdump
The iscollectinfo command can also be used with Interstage Application Server Web-J Edition.
23-1
Chapter 23: Maintenance Commands
iscollectinfo
Name
iscollectinfo
Batch information collection tool.
Synopsis
iscollectinfo [-M system] [-d directory]
Description
The iscollectinfo command collects Interstage investigation data. If a problem occurs, use this
command to collect investigation data before calling your Fujitsu SE.
The options and parameters that can be specified with this command are explained below:
-d
This option specifies the directory in which investigation data is to be stored. Investigation data is stored
in the following format:
<Specified directory>\collect\<YYYYMMDDHHMMSS>
<Specified directory>/collect/<YYYYMMDDHHMMSS>/<system>
<Specified directory>/collect/<YYYYMMDDHHMMSS>/default
Note
<YYYYMMDDHHMMSS> consists of four characters for the year, two for the month, two for the day, two
for hours, two for minutes, and two for seconds. For instance, 20030123123456 means 12:34:56
January 23, 2003. <system> indicates the name of the system to be operated.
If this option is not specified, the system prompts for the storage destination directory in interactive
mode. The default is the current directory. In response to the system prompt, specify the storage
destination directory.
-M system
This option specifies the name of the applicable system when an extended system is generated. If this
option is omitted, the default system is applicable.
23-2
iscollectinfo
This option can be specified with the following product:
−
Interstage Application Server Enterprise Edition
Notes
•
Execute this command immediately after a problem occurs.
•
Execute this command with administrator authority.
•
The following messages may be output when investigation data is collected, no response is
necessary and tthey may be ignored:
IJServer10007
IJServer10008
es10924
od10726
od10719
Remark
•
The time taken for data collection is about 5 minutes, this may vary depending on the machine
environment.
•
If the command is executed with default settings, the size of disk space required for data collection
is about 100 megabytes. If the default settings are changed to increase the sizes of various log
files, more free disk space is required. Allow for a sufficient size of free space on the disk on which
investigation data is to be stored.
23-3
Chapter 23: Maintenance Commands
esdump
Name
esdump
Outputs the Event Service shared-memory information
Synopsis
esdump
[-M system]
Description
The esdump command outputs shared-memory information.
Shared-memory information is output to the following location:
(Default installation path)
C:\Interstage\eswin\var\ES.XXX (XXX is a decimal value of treble.).
(Default installation path)
/var/opt/FJSVes/ES.XXX (XXX is a decimal value of treble.).
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority.
Examples
esdump
23-4
eslogdump
eslogdump
Name
eslogdump
Outputs the Event Service trace information.
Synopsis
eslogdump
[-b file] [-M system]
Description
The eslogdump command outputs trace information, which was collected in memory, to the trace
information file (binary file).
The trace information file is allocated to the following location:
(Default installation path)
C:\Interstage\eswin\var\ESLOG.XXX (XXX is a decimal value of treble.).
(Default installation path)
/var/opt/FJSVes/ESLOG.XXX (XXX is a decimal value of treble.).
The maximum number of trace information files can be specified in the traceconfig file. If all trace
information files are full, older files are overwritten.
For information on the traceconfig file, refer to "Event Service Environment Definition” in the Tuning
Guide.
-b file
This option converts the trace file (binary file) specified by file into the text format.
The text format file is output with name ESLOGXXX.txt to the location where the trace file is stored.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Notes
•
Execute this command with Administrator authority.
23-5
Chapter 23: Maintenance Commands
Examples
23-6
eslogdump
eslogdump
-b
C:\Interstage\eswin\var\ESLOG001
eslogdump
eslogdump
-b
/var/opt/FJSVes/ESLOG001
irlogdump
irlogdump
Name
irlogdump
Invokes Interface Repository log data output or continuous Interface Repository log data output, or stops
Interface Repository log data output.
Synopsis
(1) To invoke log data output:
irlogdump [-M system]
(2) To invoke continuous log data output:
irlogdump –p [-M system]
(3) To stop log data output:
irlogdump –s [-M system]
Description
This command outputs the Interface Repository log data.
Log data output is only invoked when logging (log collection) = ‘yes' is specified in irconfig (See the
following for storage directory details.). The log file is output to the space specified by logfile path in
irconfig.
Storage directory (Default installation path)
C:\Interstage\ODWIN\etc\irconfig
Storage directory (Default installation path)
/etc/opt/FSUNod/irconfig
Storage directory
/etc/opt/FJSVod/irconfig
23-7
Chapter 23: Maintenance Commands
The options and arguments of this command are as follows:
-p
This parameter specifies that the command outputs log data from memory, and subsequently to a log
file, continuously.
-s
This parameter specifies that the command stops continuous log data output.
Continuous log data output continues until the Interface Repository is deactivated.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
Specify the following directory for environment variable OD_HOME when this command is executed:
Windows®: C:\Interstage\ODWIN
Solaris OE: /opt/FSUNod
Linux: /opt/FJSVod
Messages
The following messages can be displayed at command execution:
No existing environment variable:OD_HOME
The environment variable “OD_HOME” has not been set.
Illegal command line
The parameter specified in the command is invalid.
No logging data
Log data could not be found. Log data collection has not been specified in the irconfig file.
Illegal logfile path
The output destination path for the log file is incorrect. The output destination directory could not be
found, or the user is not authorized to write data.
Illegal logging memory size
The shared-memory size specification for log collection is invalid. The specification of logging memory
size in the irconfig file is invalid.
OpenBuffer error(12)
The ObjectDirector or Interface Repository cache server has not been started. This message can be
displayed twice.
23-8
odcvttrace
odcvttrace
Name
odcvttrace
Conversion of trace information to text format.
Synopsis
odcvttrace -f tracefile
Description
The odcvttrace command converts the trace file (binary) that is output with the odformtrace command,
to the readable text file. File name of the text file becomes the tracefile that is specified with the -f
option to which ".txt" is added.
The options of this command are as follows:
-f tracefile
Specifies the file name of the trace file that is output with the odformtrace command.
Example
odcvttrace -f trace0012.log
23-9
Chapter 23: Maintenance Commands
odformsnap
Name
odformsnap
Edits and outputs snapshot information.
Synopsis
odformsnap [-i ImplId] … [-p pid] … [-M system]
Description
This command outputs snapshot information. Snapshot information is output as a file to the current
directory. The name of the file output is odsnap_all.
When this command is executed without options specified, snapshot information is output for all CORBA
applications. When an option is specified, the snapshot information for the specified process ID or
implementation repository ID is output.
The options of this command are as follows:
-i ImplID
Outputs the snapshot information for the process corresponding to the implementation repository ID
specified by ImplID. Information for multiple implementation repository IDs can be output by specifying
–i ImplID multiple times.
The output file name is odsnap,ImplID.
-p pid
Outputs the snapshot information for the process corresponding to the process ID specified by pid.
Information for multiple process IDs can be output by specifying –p pid multiple times.
The output file name is odsnap,pid.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
23-10
odformsnap
Notes
•
If characters other than alphanumerics (a – z, A –Z, 0 – 9) are used in a implementation repository
ID, the file name output by the –i option will show these characters as underscores. For example,
the output file for interface repository ID IDL:intf1/test1:1.0” would be
odsnap.IDL_intf1_test1_1_1_0”.
•
If implementation information is updated after the odstartsnap command is executed, no snapshot
information will be output, even if the implementation repository ID is specified in the –i option.
•
If process information specified by the –i, –p options is not present in memory, no snapshot
information will be output.
•
Specify process ID displayed by the odlistsnap command for process ID specified by -p option.
Examples
odformsnap
odformsnap –p 203
odformsnap –i IDL:test1/intf1:1.0 –p 507
23-11
Chapter 23: Maintenance Commands
odformtrace
Name
odformtrace
Output of the trace file.
Synopsis
odformtrace
[-p pid]
[-d dir]
[-M system]
Description
The odformtrace command outputs the trace information that was acquired from the memory to the
trace file (binary).
When option is not specified in this command, the trace information of the all CORBA applications is
output. The trace information is output as follows.
(Default installation path)
C:\Interstage\ODWIN\var\trace\traceXXXX.log (XXXX is a hexadecimal value).
(Default installation path)
/opt/FSUNod/var/trace/traceXXXX.log (XXXX is a hexadecimal value).
/opt/FJSVod/var/trace/traceXXXX.log (XXXX is a hexadecimal value).
If an old directory having the same name exists in the output target file of the trace information, suffix of
the old file is changed from "log" to "old" and is stored in the same directory.
Options of the odformtrace command are explained as follows.
-p pid
The trace information of the process that corresponds to the process ID that was specified with pid is
output to the trace file.
-d dir
The directory in which trace file is stored is changed to the directory that is specified with dir.
23-12
odformtrace
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Examples
odformtrace
odformtrace -p 203
odformtrace -p 203 -d C:\TEMP\TRACE
odformtrace -p 203 -d /tmp/trace
23-13
Chapter 23: Maintenance Commands
odfreesnap
Name
odfreesnap
Clears snapshot information.
Synopsis
odfreesnap
[-M system]
Description
This command clears snapshot information collected with the odstartsnap command. Refer to the
odstartsnap command.
The options of this command are as follows:
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Example
odfreesnap
23-14
odprtcurparam
odprtcurparam
Name
odprtcurparam
Displays the consumption of parameters of the config file.
Synopsis
odprtcurparam [-M system]
Description
The odprtcurparam command displays the consumption of the following parameters for the config file
(the operating environment file of the CORBA service). For details about parameters of the config file,
refer to config in the Tuning Guide.
•
max_IIOP_resp_con
(Total number of client application processes that can connect.)
•
max_IIOP_resp_requests
(Total number of requests from the client application connected)
•
number_of_common_buffer
(Number of buffers for queue control)
•
max_processes
(Maximum number of processes.)
•
max_exec_instance
(Maximum number of threads (or processes) used for server application request execution.)
This command directly references shared memory the CORBA service uses and displays the current
consumption of parameters above. By using this function, the user can compare the estimate at system
design (which are included in the settings of the config file) with the actual consumption and check
whether the estimate is correct in advance. In addition, the user can also check the consumption
periodically during operation.
23-15
Chapter 23: Maintenance Commands
How the consumption is displayed is shown below. The time when the command is executed appears
at the top followed by other information items (name, value, max, and limit).
>odprtcurparam
Thu Jan 23 20:20:36 2003
name
value
max
limit
---------------------------------------------------IIOP_resp_con
32
80
120
IIOP_resp_requests
203
160
280
number_of_common_buffer
64
32
280
processes
51
300
exec_instance
320
960
name
A parameter name.
For the parameters other than number_of_common_buffer, "max_" is omitted.
value
Current consumption value.
max
Maximum value defined in the config file.
limit
Maximum value for automatic expansion
If the value is defined in the config file, the value is output. If not, the default value is output.
This item is displayed only for max_IIOP_resp_con, max_IIOP_resp_requests, and
number_of_common_buffer.
The options of this command are as follows:
-M system
Specifies the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
Note
This command cannot display the consumption of parameters for an application which uses a library for
clients and Portable-ORB.
Example
odprtcurparam
23-16
odprthdrtrace
odprthdrtrace
Name
odprthdrtrace
Display of the header information of the trace information.
Synopsis
odprthdrtrace -f tracefile
Description
The odprthdrtrace command displays the process ID (ProcessID) and the command execution synopsis
(CommandLine) from the trace file that is output with the odformtrace command.
The options of this command are as follows:
-f tracefile
Specifies the file name of the trace file that is output with the odformtrace command.
Example
odprthdrtrace -f trace0012.log
23-17
Chapter 23: Maintenance Commands
odstartsnap
Name
odstartsnap
Starts collection of snapshot information.
Synopsis
odstartsnap [-i ImplId] … [-p pid] …
[-M system]
Description
This command starts the collection of snapshot information.
This command collects snapshot information in common memory. The odformsnap command outputs
snapshot information. Refer to the odformsnap command.
When this command is executed without options specified, snapshot information is collected for all
CORBA applications. When an option is specified, the snapshot information for the specified process ID
or implementation repository ID is collected.
The options of this command are as follows:
-i ImplID
Starts the collection of snapshot information for the process corresponding to the implementation
repository ID specified by ImplID.
-p pid
Starts the collection of snapshot information for the process corresponding to the process ID specified
by pid.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
23-18
odstartsnap
Notes
•
The implementation repository ID specified in the –i option must be registered.
•
Collection of snapshot information is automatically halted if the implementation repository ID
specified in the –i option is deleted by the OD_impl_inst command.
•
The CORBA application corresponding to the process ID specified in the –p option must be active.
•
Specify process ID displayed by the odlistsnap command for process ID specified by -p option.
Examples
odstartsnap
odstartsnap –p 203
odstartsnap –i IDL:test1/intf1:1.0 –p 507
23-19
Chapter 23: Maintenance Commands
odstopsnap
Name
odstopsnap
Stops collection of snapshot information.
Synopsis
odstopsnap [-i ImplId] … [-p pid] … [-M system]
Description
This command stops the collection of snapshot information. The odformsnap command outputs
snapshot information. Refer to the odformsnap command.
When this command is executed without options specified, collection of snapshot information is stopped
for all CORBA applications. When an option is specified, the collection of snapshot information for the
specified process ID or implementation repository ID is stopped.
The options of this command are as follows:
-i ImplID
Stops the collection of snapshot information for the process corresponding to the implementation
repository ID specified by ImplID.
-p pid
Stops the collection of snapshot information for the process corresponding to the process ID specified
by pid.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes target.
This option can be specified with Interstage Application Server Enterprise Edition.
23-20
odstopsnap
Notes
•
The implementation repository ID specified in the –i option must be registered.
•
The CORBA application corresponding to the process ID specified in the –p option must be active.
•
Specify process ID displayed by the odlistsnap command for process ID specified by -p option.
Examples
odstopsnap
odstopsnap –p 203
odstopnap –i IDL:test1/intf1:1.0 –p 507
23-21
Chapter 23: Maintenance Commands
otsgetdump
Name
otsgetdump
Collects the dump file of the Database Linkage Service being executed.
Synopsis
otsgetdump {[-get]|[-on|-off]} {[-all]|[-c] [-s] [-n resource-definitionname1,resource-definition-name2 ...] [-w] [-e] [-t]}
Description
When an error occurs in the Database Linkage Service, the system operating status is output for
maintenance. This command is executed on the machines where the dump is output.
The following two collection modes are available:
Temporary Collection:
When the -get option is specified, perform dumping in temporary collection mode. When the -get, -on
and -off options are all omitted, the -get option is presumed to have been specified.
Permanent Collection:
If the -on option is specified, the command begins collecting the dump, and stops when the -off option
is specified.
The options of this command are as follows:
-get
A dumping file is extracted in temporary collection mode.
-on
Declares the start of the dump collection.
-off
Declares the end of the dump collection.
-all
Dump of all the following:
Control table status, Database Linkage Service system trace, Resource Manager trace, monitor process
trace, recovery process trace, and internal control.
23-22
otsgetdump
-c
Dump of the control table status.
Regardless of the mode, it is always extracted in temporary collection mode.
A dump file is created with the name otsctl.nnn in the Database Linkage Service install folder\var.
A dump file is created with the name otsctl.nnn in the product storage directory/var.
-s
Dump of the Database Linkage Service system trace.
A dump file is created with the name TranFactorynnn in the Database Linkage Service install
folder\var.
A dump file is created with the name TranFactorynnn in the product storage directory/var.
-n
Dump of trace of specified Resource Manager.
Multiple filenames can be specified by separating each filename with a comma (“,”).
A dump file is created with the name nnn in the Database Linkage Service install folder\var.
A dump file is created with the name nnn in the the product storage directory/var.
-w
Dump of trace of monitor process
A dump file is created with the name otsmngernnn in the Database Linkage Service install
folder\var.
A dump file is created with the name otsmngernnn in the product storage directory/var.
23-23
Chapter 23: Maintenance Commands
-e
Dump of recovery process
A dump file is created with the name otsrecoverynnn in the Database Linkage Service install
folder\var.
A dump file is created with the name otsrecoverynnn in the product storage directory/var.
-t
Dump of internal control
Regardless of collection mode, it is always extracted in temporary collection mode.
A dump file is created with the name TACE.nnn in the Database Linkage Service install folder\var.
A dump file is created with the name TACE.nnn in the product storage directory/var.
Notes
23-24
•
Execute this command with Administrator authority.
•
The size of the dump file can be increased. Therefore allocate a sufficient size.
•
A number is assigned to the nnn component of each collected dump filename.
•
When collecting dumps of the resource Manager for JTS, all dumps must be collected by specifying
no option or -all.
otsgetdump
Examples
Collects all dump.
otsgetdump -all
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
name
name
name
Name
name
name
name
of management table :C:\PROGRA~1\ots\var\otsctl.001
of OTS System trace :C:\PROGRA~1\ots\var\TranFactory001
of Resource trace :C:\PROGRA~1\ots\var\def_rsc001 \
: C:\ots\sample\def_rsc): C:\ots\sample\def=rsc
of inside control : C:\PROGRA~1\ots\var\TACE.001
of observation process : C:\PROGRA~1\ots\var\otsmnger001
of Recovery trace : C:\PROGRA~1\ots\var\otsrecovery001
Collects Database Linkage Service system trace and resource.
otsgetdump -s -n resourcedef1,resourcedef2
Dump file name of OTS System trace : C:\PROGRA~1\ots\var\TranFactory001
Dump file name of Resource trace
: C:\PROGRA~1\ots\var\resourcedef1001 \
(Resource Name : \home\ots\resourcedef1)
Dump file name of Resource trace
: C:\PROGRA~1\ots\var\resourcedef2001 \
(Resource Name : \home\ots\resourcedef2)
Starts collecting all dumps in permanent collection mode.
otsgetdump -on
Dump file name of management table : C:\PROGRA~1\ots\var\otsctl.000
Dump file name of inside control
: C:\PROGRA~1\ots\var\TACE.001
Stops collecting all dumps in permanent collection mode.
otsgetdump -off
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
name
name
name
Name
name
name
name
of management table :C:\PROGRA~1\ots\var\otsctl.001
of OTS System trace : C:\PROGRA~1\ots\var\TranFactory001
of Resource trace
: C:\PROGRA~1\ots\var\resourcedef1001 \
: \home\ots\resourcedef1)
of inside control : C:\PROGRA~1\ots\var\TACE.002
of observation process : C:\PROGRA~1\ots\var\otsmnger001
of Recovery trace : C:\PROGRA~1\ots\var\otsrecovery001
23-25
Chapter 23: Maintenance Commands
Collects all dump.
#otsgetdump -all
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
name
name
name
Name
name
name
name
of management table
of OTS System trace
of Resource trace
: /ots/sample/def_rsc)
of inside control
of observation process
of Recovery trace
: /ots/FSUNots/var/otsctl.001
: /ots/FSUNots/var/TranFactory001
: /ots/FSUNots/var/def_rsc001 \
: /ots/FSUNots/var/TACE.001
: /ots/FSUNots/var/otsmnger001
: /ots/FSUNots/var/otsrecovery001
Collects Database Linkage Service system trace and resource.
#otsgetdump -s
Dump file name
Dump file name
(Resource Name
Dump file name
(Resource Name
-n resourcedef1, resourcedef2
of OTS System trace
: /ots/FSUNots/var/TranFactory001
of Resource trace
: /ots/FSUNots/var/resourcedef1001 \
: /home/ots/resourcedef1)
of Resource trace
: /ots/FSUNots/var/resourcedef2001 \
: /home/ots/resourcedef2)
Starts collecting all dumps in permanent collection mode.
#otsgetdump -on
Dump file name of management table
Dump file name of inside control
: /opt/FSUNots/var/otsctl.000
: /opt/FSUNots/var/TACE.001
Stops collecting all dumps in permanent collection mode.
#otsgetdump -off
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
23-26
name
name
name
Name
name
name
name
of management table
: /opt/FSUNots/var/otsctl.001
of OTS System trace
: /opt/FSUNots/var/TranFactory001
of Resource trace
: /opt/FSUNots/var/resourcedef1001 \
: /home/ots/resourcedef1)
of inside control
: /opt/FSUNots/var/TACE.002
of observation process : /opt/FSUNots/var/otsmnger001
of Recovery trace
: /opt/FSUNots/var/otsrecovery001
otsgetdump
Collects all dump.
#otsgetdump -all
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
name
name
name
Name
name
name
name
of management table
of OTS System trace
of Resource trace
: /ots/sample/def_rsc)
of inside control
of observation process
of Recovery trace
: /ots/FJSVots/var/otsctl.001
: /ots/FJSVots/var/TranFactory001
: /ots/FJSVots/var/def_rsc001 \
: /ots/FJSVots/var/TACE.001
: /ots/FJSVots/var/otsmnger001
: /ots/FJSVots/var/otsrecovery001
Collects Database Linkage Service system trace and resource.
#otsgetdump -s
Dump file name
Dump file name
(Resource Name
Dump file name
(Resource Name
-n resourcedef1, resourcedef2
of OTS System trace
: /ots/FJSVots/var/TranFactory001
of Resource trace
: /ots/FJSVots/var/resourcedef1001 \
: /home/ots/resourcedef1)
of Resource trace
: /ots/FJSVots/var/resourcedef2001 \
: /home/ots/resourcedef2)
Starts collecting all dumps in permanent collection mode.
#otsgetdump -on
Dump file name of management table
Dump file name of inside control
: /opt/FJSVots/var/otsctl.000
: /opt/FJSVots/var/TACE.001
Stops collecting all dumps in permanent collection mode.
#otsgetdump -off
Dump file
Dump file
Dump file
(Resource
Dump file
Dump file
Dump file
name
name
name
Name
name
name
name
of management table
: /opt/FJSVots/var/otsctl.001
of OTS System trace
: /opt/FJSVots/var/TranFactory001
of Resource trace
: /opt/FJSVots/var/resourcedef1001 \
: /home/ots/resourcedef1)
of inside control
: /opt/FJSVots/var/TACE.002
of observation process : /opt/FJSVots/var/otsmnger001
of Recovery trace
: /opt/FJSVots/var/otsrecovery001
23-27
Chapter 23: Maintenance Commands
tdalllog
Name
tdalllog
Outputs the internal information of the Component Transaction Service business system.
Synopsis
tdalllog
[-M systemname]
Description
The tdalllog command outputs the internal information of the Component Transaction Service business
system.
Execute this command if a system error occurs, or as indicated by your software supplier.
Options of this command are explained as follows.
-M system
Specify the system name. If this option is omitted, operation using the default system becomes target.
Internal information is output to the following folder:
Component Transaction Service internal information1: C:\Interstage\td\trc\
Component Transaction Service internal information2:
If the isinit command was used to generate the Component Transaction Service operating environment:
TD_SETUPPATH\td001\sys\log.
If the tdsetup command was used to generate the Component Transaction Service operating
environment:
The folder specified by tdsetup command \td001\sys\log
* TD_SETUPPATH: The “TD path for system” value entered in C:\Interstage\td\etc\isreg\isinitdef.txt.
The default is C:\Interstage\td\var.
Internal information is output to the following directory:
Component Transaction Service internal information1: /var/opt/FSUNtd/trc/
Component Transaction Service internal information2: Setup directory /sys/log/
23-28
tdalllog
Internal information is output to the following directory:
Component Transaction Service internal information1: /var/opt/FJSVtd/trc/
Component Transaction Service internal information2: Setup directory /sys/log/
Note
•
Execute this command with Administrator authority.
23-29
Chapter 23: Maintenance Commands
23-30
Part 9
Appendixes
Appendix A
Load Balancing Operation Commands
This appendix details the Load Balancing operation commands.
Note
The Load Balancing operation commands can be used in the following product:
•
Interstage Application Server Enterprise Edition.
A-1
Appendix A: Load Balancing Operation Commands
odadministerlb
Name
odadministerlb
Generates, registers, and deletes object references controlled by the load balance function.
Synopsis
(1) Generate and register an object reference:
odadministerlb -c IntfID [-a ImplID] [-h HostName -p PortNum] –n name
[-L Locale | -v version] [-M system]
(2) Delete an object reference:
odadministerlb -d -c IntfID [-a ImplID] [-h HostName -p PortNum] -n name
[-M system]
(3) Change the default object:
odadministerlb -c IntfID [-a ImplID] [-h HostName -p PortNum] –n name –r
[-L Locale | -v version] [-M system]
Description
This command generates and registers object references controlled by the load balance function. In
addition, it deletes the reference from the object group. It also modifies the properties of the generated
object reference.
The options and arguments of this command are as follows:
-c IntfID
Creates an object reference with the Interface Repository ID specified in IntfID. Specify the Repository
ID (within 256 characters), that identifies the module, and interface defined in IDL, in Interface
Repository ID. The repository ID format is described as follows.
Format: Identification Information:Version
Format: Specify IDL.
Identification Information: Use “/” as delimiter for module name and interface name defined in IDL.
Version: Specify “1.0”. Version is optional.
-a ImplID
Specify this option when the identifier is different for Implementation Repository ID and Interface
Repository ID. Specify the string specified in the OD_impl_inst command -r option. If this option is
omitted, the Implementation Repository ID creates an object with the same identifier as that of the
Interface Repository.
A-2
odadministerlb
-h HostName
Specify the address information of the request receiving server for the host name, DNS name or IP
address. When manually registering the object for the transaction application, only the host name can
be specified.
-p PortNum
The port number which receives a request is specified.
-n name
Registers the specified name with the Naming Service when creating an object reference. The naming
context can also be specified in name. A hierarchy of naming contexts can be specified in name,
specified in character array binding name format. For details, refer to the Character String Binding
Names in the Distributed Application Development Guide (CORBA Service Edition).
An error is caused in a non-existent naming context is specified.
-d
Deletes an object reference.
-r
Changes the default object.
-v version
Specify the version to be set in the object reference.
Refer to the OD_or_adm command for details of the version that can be specified.
-L Locale
Specify the server application conversion code type to be set in the object reference of the default object.
Refer to the OD_or_adm command for details of codes that can be specified.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Notes
•
When executing this command, the object group specified in name must already be registered.
•
Object references with the same port name, but different port numbers, cannot be registered.
•
Multiple objects operating on the same server can be registered as an object group by modifying
their Implementation Repository ID.
•
If the default object is modified by specifying the -r option, the registered default object is deleted
from the object group.
•
The default object cannot be deleted.
•
With the exception of the default object, delete all objects in the object group to be deleted before
deleting the object group.
A-3
Appendix A: Load Balancing Operation Commands
oddisplaylbobj
Name
oddisplaylbobj
Displays the load balance object group.
Synopsis
oddisplaylbobj -n Name [-M system]
Description
The argument of this command is as follows:
-n Name
Specifies the name of the load balance object group to be displayed in character array binding name
format. For details, refer to the Character String Binding Names in the Distributed Application
Development Guide (CORBA Service Edition).
This command displays information about the load balance object group.
Load Balance Group Name
Displays object group name to be displayed.
Load Balance Type
Displays “roundrobin”.
The following information is displayed for each object registered in the object group.
Address
The host name and port number separated by a colon (:).
For the default object, “DEFAULT” is displayed after the port number.
Stat
The status of the server controlled by the load balance function.
UP :
Indicates the running server
DOWN :
Indicates the down server
ImplID
The object's Implementation Repository ID is displayed.
IntfID
The object's Interface Repository ID is displayed.
Version
The object's IOR version is displayed.
A-4
oddisplaylbobj
Locale
The object's code type is displayed.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Note
If UNKNOWN is displayed in Stat, check whether the server address is set correctly. For details, refer to
the High Availability System Guide.
Example
OD_or_adm -g lb -c IDL:intf01:1.0 -a IDL:TEST:1.0 -n GROUP01
odadministerlb -c IDL:intf01:1.0 -a IDL:TEST2:1.0 -n GROUP01
UX:odadministerlb: INFO: od31101:Command is executed successfully.
oddisplaylbobj -n GROUP01
Load Balance Group Name : GROUP01
Load Balance Type
: roundrobin
Address : r2d2:8002 (DEFAULT)
Stat
: UP
ImplID : IDL:TEST:1.0
IntfID : IDL:intf01:1.0
Version: 1.1
Address : r2d2:8002
Stat
: UP
ImplID : IDL:TEST2:1.0
IntfID : IDL:intf01:1.0
Version: 1.1
A-5
Appendix A: Load Balancing Operation Commands
odnotifydown
Name
odnotifydown
Notifies the load balance function that the server is down.
Synopsis
odnotifydown hostname [-M system]
Description
This command notifies the load balance function that the server is down. It stops sending requests to
the server object of the down server.
The argument of this command is as follows:
hostname
Specify the host name or IP address of the down server.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
A-6
odnotifyrecover
odnotifyrecover
Name
odnotifyrecover
Notifies the load balance function that the down server has been restored.
Synopsis
odnotifyrecover hostname [-M system]
Description
This command notifies the load balance function that the down server has been restored. It restarts
sending requests to the server object of the restored server.
The argument of this command is as follows:
hostname
Specify the host name or IP address of the recovered server.
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
A-7
Appendix A: Load Balancing Operation Commands
odsetlbo
Name
odsetlbo
Sets operating environment for the load balance function
Synopsis
odsetlbo {-l [-m ThreadMax] | -r -h HostName -p PortNum | -d} [-M system]
Description
This command registers the LBO for initial service. Execute this command each time LBO is to be used.
The arguments and options of this command are as follows:
-l
Add the LBO to the Implementation Repository.
Registers the LBO operating on the local server for initial service.
And, registers load balance function in the service.
-m ThreadMax
Register the maximum thread concurrency of the object group register, search, and delete processes.
Specify a value equal to double the maximum multi-processes. A number between 16 and 1000 can be
specified. The default value is 16.
-r
Register the LBO operating on another server for initial service.
In the load balance environment, specify the server where the LBO is running, from the machine where
the LBO is not running.
And, it is deleted when a load balance function is registered in the service.
-h HostName
Specify the hostname of another server.
-p PortNum
Specify the port number of another server.
-d
Deletes the load balance function from the Implementation Repository. The load balance function is
deleted from the initial service. The load balance function is deleted from the service.
A-8
odsetlbo
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Notes
•
Registration of an initial service has to be performed on each machine where the load balance
function is to be used before using the load balance function. However, it is not required for clients
that only use the Naming Service function. It is required only for the machines using API or load
balance function commands.
•
Execute this command with administrator authority.
•
The value specified at ThreadMax depends on the max_exec_instance parameter of the ORB core
environment definition, obtained using the following equation.
max_exec_instance - Total number of multiple level threads of the other server application. The
default value is 512.
•
Do not use the following command while using this command:
odadmin_ex/odadmin
•
Set the following environment variable (if not already set) while executing this command:
OD_HOME: CORBA Service installation directory.
A-9
Appendix A: Load Balancing Operation Commands
odstartlbo
Name
odstartlbo
Starts the load balance function
Synopsis
odstartlbo [-M system]
Description
This command starts the load balance function.
The arguments and options of this command are as follows:
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Notes
odstartlbo is a command for service start with Solaris OE.
In the case of service start with Windows NT®/Windows® 2000, a load balance function is provided with
the start of the “NS LoadBalancingOption” service.
A-10
•
Execute this command with administrator authority.
•
Set the following environment variable (if not already set) while executing this command:
OD_HOME: CORBA Service installation directory
odstoplbo
odstoplbo
Name
odstoplbo
Stops the load balance function
Synopsis
odstoplbo [-M system]
Description
This command stops the load balance function.
The arguments and options of this command are as follows:
-M system
Specify the operation target system name “system” when an extended system is generated. If this
option is omitted, operation using the default system becomes the target.
Notes
•
Use the odstoplbo command to stop the service under Solaris OE. Under Windows
NT®/Windows® 2000, stop the NS Load Balancing Option to stop the load balancing function.
•
Execute this command with administrator authority.
•
Set the following environment variable (if not already set) while executing this command:
OD_HOME: CORBA Service installation directory
A-11
Appendix A: Load Balancing Operation Commands
A-12
Appendix B
Server Machine Monitor Agent Commands
This appendix details the Server Machine Monitor Agent Commands.
B-1
Appendix B: Server Machine Monitor Agent Commands
isaddtarget
Name
isaddtarget
Adds an IP address to be monitored to a started SMM agent.
Synopsis
isaddtarget ip-address
Description
This command adds an IP address to be monitored to an already started SMM agent. Execute this
command at the monitored server.
The argument for this command is as follows:
ip-address
Specify the IP address of the SMM to be monitored.
Notes
•
The SMM agent must be started to execute this command.
•
The validity of the IP address is not checked.
•
A change by this command becomes invalid due to the stop of the “ServerMachineMonitorAgent”
service. Specify an IP address with an issetsmma command when you want to change it steadily.
Example
isaddtarget 172.16.71.1
B-2
isdeletetarget
isdeletetarget
Name
isdeletetarget
Deletes the IP address of the server being monitored from the started SMM agent
Synopsis
isdeletetarget ip-address
Description
This command removes the IP address to be monitored from the started SMM agent. Execute this
command at the monitored server.
The argument for this command is as follows:
ip-address
Specify the IP address of the SMM to be monitored.
Notes
•
The SMM agent must be started to execute this command.
•
Specify the IP address of the server being monitored by this command.
•
A change by this command becomes invalid due to the stop of the “ServerMachineMonitorAgent”
service. Specify an IP address with an issetsmma command when you want to change it steadily.
•
Even if the IP address to be monitored is lost while this command is executing, the SMM agent
does not stop. To stop the SMM agent on Windows NT, execute the isstopsmma command. If the
"ServerMachineMonitorAgent” stops, the SMM agent stops.
Example
isdeletetarget 172.16.71.1
B-3
Appendix B: Server Machine Monitor Agent Commands
isdisplaysmm
Name
isdisplaysmm
Displays the monitor status of SMM.
Synopsis
isdisplaysmm
Description
This command displays the monitor status of the SMM, and is executed at the monitored server.
Displays the following information while starting the SMM:
HBI:
The time interval required for the SMM agent to communicate with SMM.
It is the value specified at the issetsmm command -h option.
DT:
The time interval required for the SMM to recognize that the SMM agent is down.
It is the value specified at the issetsmm command -t option.
Down Shell:
The process name to be executed when the monitored server is found to be down.
SMM (pathname of down shell):
The path specified at the -D option of issetsmm is displayed.
SMMA:
The path name of the down shell to be executed on the SMM agent.
NONE:
When reporting a down state to the load balance function.
Recover Shell:
The process name to be executed when the monitored server is recovered.
SMM (pathname of recover shell):
The path specified at the -R option of issetsmm is displayed.
SMMA:
The path name of the recovery shell to be executed on the SMM agent.
NONE:
When reporting recovery to the load balance function.
B-4
isdisplaysmm
Server IP
The IP address of the monitored server for the SMM. If the SMM agent is not running, the IP address is
not displayed.
Note
Before executing the isdisplaysmm command, start the SMM.
Example
Isdisplaysmm
HBI:10
DT:30
Down Shell:SMM(C:\IS\DSHELL.BAT )
Recover Shell:SMM(C:\IS\RSHELL.BAT )
Server IP
172.16.71.1
172.16.71.22
HBI:10
DT:30
Down Shell:SMM(/IS/DSHELL.BAT )
Recover Shell:SMM(/IS/RSHELL.BAT )
Server IP
172.16.71.1
172.16.71.22
B-5
Appendix B: Server Machine Monitor Agent Commands
issetsmm
Name
issetsmm
Registers the SMM for service of Windows NT®)/Windows® 2000.
Synopsis
issetsmm [-h HBI] [-t DT] [{-D down shell | -d}] [{-R recover shell| -r}]
Description
This command registers the SMM for service of Windows NT®/Windows® 2000. This command is
executed on the monitored server.
The options and arguments of this command are as follows:
-h HBI
Specify (at HBI) the time interval required for the SMM agent to communicate with SMM. The SMM
agent sends its operating status to the SMM at time intervals specified by the HBI value.
An integer value from 1 to 3599 can be specified in seconds for HBI. The default value is 5.
-t DT
Specify (at DT) the time interval required for the SMM to recognize that the SMM agent is down. If no
operating status is reported from the SMM agent after the specified time interval, the SMM interprets
that the SMM agent is down.
An integer value from 2 to 3600 can be specified in seconds for DT.
The default value is 10.
-D down shell
When the SMM agent is found to be down, specify the absolute path of the batch file to be executed
from the SMM (within 255 bytes). This batch file is called the down shell.
If options -D or -d are omitted, the SMM notifies the load balance function about the down agent of the
monitored server.
-R recover shell
When the SMM agent is found to have recovered, specify the absolute path of the batch file to be
executed from the SMM (within 255 bytes). This batch file is called the recover shell.
If options -R or -r are omitted, the SMM notifies the load balance function about the restored agent of
the monitored server.
B-6
issetsmm
-d
When the SMM agent is found to be down, specify this option if a batch file is to be executed from the
SMM.
-r
When the SMM agent is found to have recovered, specify this option if a batch file is to be executed
from the SMM agent.
Notes
•
The Administrator of the local group can execute this command.
•
When re-registering the SMM for service of Windows NT®/Windows® 2000, use the isunsetsmm
command before this command.
•
Execute this command first, when starting the SMM service.
•
SMM should start with the machine that “Naming Service” service surely works because “Naming
Service” service is the service related to dependence of the start of SMM.
•
DT should be greater than HBI. Considering the delay in sending working status from the SMM
agent to the SMM, set the difference as large as possible.
•
The monitored server's IP address is returned from the SMM as the first parameter (%1). Specify
this IP address when executing the odnotifydown command from the down shell.
•
The recovered server's IP address is returned from the SMM as the first parameter (%1). Specify
this IP address when executing the odnotifyrecover command from the recover shell.
•
Specify the down shell and recover shell on the machine where the SMM is running.
•
The down shell and recover shell are executed successively.
•
Since standard output cannot be used in a down shell or recover shell, write any information to a
file.
•
Specify the batch file as a down shell and recover shell. And don't omit a file extension (.BAT).
•
To run the SMM, start load balance function on the same machine.
Examples
To start the down shell and recover the shell from the SMM:
issetsmm -h 10 -t 30 -D C:\IS\DSHELL.BAT -R C:\IS\RSHELL.BAT
To start the down shell from the SMM agent:
issetsmm –d
B-7
Appendix B: Server Machine Monitor Agent Commands
issetsmma
Name
issetsmma
Registers the SMM agent for service of Windows NT®/Windows® 2000
Synopsis
issetsmma [-d down shell] [-r recover shell] ip-address ...
Description
This command registers the SMM agent for service of Windows NT®/Windows® 2000. This command is
executed at the monitored server.
The arguments and options of this command are as follows:
-d down shell
When down notification is received from the SMM, specify the absolute path of the batch file to be
executed from the SMM agent (within 255 bytes). Don't include a blank in batch file name specified as a
going down shell, or the path name.
-r recover shell
When recover notification is received from the SMM, specify the absolute path of the batch file to be
executed from the SMM agent (within 255 bytes). Don't include a blank in batch file name specified as a
going recover shell, or the path name
ip-address
Specify the IP address of the monitored server.
B-8
issetsmma
Notes
•
The Administrator of the local group can execute this command.
•
When re-registering the SMM agent for service of Windows NT®/Windows® 2000, use the
isunsetsmma command before this command.
•
Execute this command first, when starting the SMM agent as a service.
•
The IP address of the down monitored server is passed from the SMM as the first parameter (%1).
Specify this IP address when executing the odnotifydown command from the down shell.
•
The IP address of the recover monitored server is passed from the SMM as the first parameter
(%1). Specify this IP address when executing the odnotifyrecover command from the recover shell.
•
Specify the down shell and recover shell on the machine where the SMM agent is running.
•
The down shell and recover shell are executed successively.
•
Since standard output cannot be used in the down shell or recover shell, write any information to a
file.
•
Specify the batch file as a down shell and recover shell. And, don't omit a file extension (.BAT).
Example
issetsmma -d C:\IS\DSHELL.BAT -r C:\IS\RSHELL.BAT 172.16.71.1
B-9
Appendix B: Server Machine Monitor Agent Commands
isstopsmm
Name
isstopsmm
Stops SMM.
Synopsis
isstopsmm
..
Description
The isstopsmm command stops SMM. This command is executed in the monitored server.
Note
Do not stop the CORBA Service before running this command.
B-10
isstartsmm
isstartsmm
Name
isstartsmm
Starts the SMM.
Synopsis
isstartsmm [-h HBI] [-t DT] [{-D down shell | -d}] [{-R recover shell| -r}]
Description
This command starts the SMM. It is executed at the monitored server. The options and arguments of
this command are as follows:
-h HBI
Specify the time interval required for the SMM agent to communicate with the SMM at HBI. The SMM
agent sends the working status to the SMM at each time interval specified at HBI. An integer value
between 1 and 3599 can be specified at HBI, in seconds. The default is 5.
-t DT
Specify the time interval required for the SMM to recognize that the SMM agent is down at DT. The SMM
recognizes that the SMM is down when the working status is not received from the SMM agent, after the
time interval specified at DT.
Between 2 and 3600 can be specified at DT, in seconds. The default is 10.
-D down-shell
When the SMM agent is found to be down, specify the absolute path of the shell script to be executed
from the SMM (within 255 bytes). This shell script is called the down shell.
If the -D or -d options are omitted, the SMM notifies the load balance function about the down agent of
the monitored server. The -D and -d options cannot be specified together.
-R recover-shell
When the SMM agent is found have recovered, specify the absolute path of the shell script to be
executed from the SMM (within 255 bytes). This shell script is called the recover shell.
If the -R or -r options are omitted, the SMM notifies the load balance function about the recover agent of
the monitored server. The -R and -r options cannot be specified together.
-d
When the SMM agent is found to be down, specify this option to execute the shell script from the SMM
agent
B-11
Appendix B: Server Machine Monitor Agent Commands
-r
When the SMM agent is found to have recovered, specify this option to execute the shell script from the
SMM agent.
Notes
•
This command is for Solaris only. The CORBA service needs to be triggered in the advance
•
Multi execution for one shared Naming Service is not possible.
•
Start the Naming Service before starting the SMM.
•
While operating the SMM, it is recommended to start the Naming Service and the load balance
function on the same machine.
•
The IP address of the down monitored server is returned as the first down shell parameter from
SMM (received as “$1” in the shell script). Specify this IP address while executing the odnotifydown
command from the down shell.
•
The IP address of the recovered monitored server is passed as the first parameter of the recover
shell from the SMM (received as “$1” in the shell script). Specify this IP address while executing the
odnotifyrecover command from the recover shell.
•
Specify the down shell and recover the shell that exists in the machine on which the SMM agent is
running.
•
The down shell and the recover shell are executed successively.
•
Since standard output cannot be used in the down shell or recover shell, write any information to a
file.
1.
When starting the down shell and recover shell from the SMM side:
Example
isstartsmm -h 10 -t 30 -D /IS/DSHELL -R /IS/RSHELL
2.
When starting the down shell from the SMM agent:
isstartsmm –d
B-12
isstartsmma
isstartsmma
Name
isstartsmma
Starts SMM agent.
Synopsis
isstartsmma [-d down-shell] [-r recover-shell] ip-address ...
Description
This command starts the SMM agent. It is executed at the monitored server.
The options and arguments of this command are as follows:
-d down-shell
When down notification is received from the SMM, specify the absolute path of the shell script to be
executed from the SMM agent (within 255 bytes).
-r recover-shell
When down notification is received from the SMM, specify the absolute path of the shell script to be
executed from the SMM agent (within 255 bytes).
ip-address
Specify the IP address for the monitored server.
B-13
Appendix B: Server Machine Monitor Agent Commands
Notes
•
The CORBA service needs to be triggered in the advance.
•
Multiple SMM agents cannot be started on the same monitored server.
•
The specified IP address is not validated.
•
The IP address of the down monitored server is returned as the first parameter from SMM (%1).
Specify this IP address when executing the odnotifydown command from the down shell.
•
The IP address of the recover monitored server is returned as the first parameter of the recover
shell from SMM (%1).
Specify this IP address when executing the odnotifyrecover command from the recover shell.
•
Specify the down shell and recover shell that exists on the machine on which the SMM agent is
running.
The down shell and recover shell are executed successively.
•
Since standard output cannot be used in the down shell or recover shell, write any information to
the file.
Example
isstartsmma -d /IS/DSHELL -r /IS/RSHELL 172.16.71.1
B-14
isstopsmma
isstopsmma
Name
isstopsmma
Stops the SMM agent on the monitored server
Synopsis
isstopsmma
Description
This command stops the SMM agent. Execute this command for the monitored server.
Note
Do not terminate the OD before executing this command.
B-15
Appendix B: Server Machine Monitor Agent Commands
isunsetsmm
Name
isunsetsmm
Deletes the SMM from service of Windows NT®/Windows® 2000.
Synopsis
isunsetsmm
Description
This command deletes the SMM from service of Windows NT®/Windows® 2000. This command is
executed on the monitored server.
Notes
B-16
•
The Administrator of the local group can execute this command.
•
Stop the SMM service before executing this command.
isunsetsmma
isunsetsmma
Name
isunsetsmma
Deletes the SMM agent from service of Windows NT®/Windows® 2000.
Synopsis
isunsetsmma
Description
This command deletes the SMM agent from service of Windows NT®/Windows® 2000. This command
is executed at the monitored server.
Notes
•
The Administrator of the local group can execute this command.
•
Stop SMM agent service before executing this command.
B-17
Appendix B: Server Machine Monitor Agent Commands
B-18
Index
apachectl, 9-2
application development commands
IDLc, 21-2
otslinkrsc, 21-21
otsmkxapgm, 21-25
tdc, 21-32
Backup commands
ijsrestore, 22-9
Backup commands
issoaprestore, 22-29
Backup commands
j2eebackup, 22-31
Backup commands
j2eerestore, 22-32
Backup commands
jmsbackup, 22-33
Backup commands
jmsrestore, 22-35
esbackupsys, 22-3
Backup commands
esrestoresys, 22-5
obfbkup, 22-37
ijsbackup, 22-7
Backup commands
Backup commands
obfrestore, 22-39
ippbackup, 22-11
Backup commands
Backup commands
odbackupsys, 22-41
ipprestore, 22-13
Backup commands
Backup commands
odexportir, 22-42
irdelete, 22-15
Backup commands
iscbackupsys, 22-17
Backup commands
iscrestoresys, 22-19
Backup commands
isguibackup, 22-21
Backup commands
isguirestore, 22-24
Backup commands
issoapbackup, 22-27
Backup commands
Backup commands
odexportns, 22-45
Backup commands
odimportir, 22-48
Backup commands
odimportns, 22-51
Backup commands
odrestoresys, 22-55
Backup commands
otsbackupsys, 22-58
Backup commands
otsrestoresys, 22-59
Index-1
Reference Manual (Command Edition) - Index
Backup commands
tdbackupsys, 22-60
Backup commands
tdrestoresys, 22-62
Cluster Service commands
tdinhibitobj, 12-7
tdlinkapm, 12-8
tdlinknormapm, 12-11
tdlistobj, 12-13, 12-14
tdsetup, 12-16
isgetstatus, 20-2
tdstart, 12-17
isrelease, 20-5
tdstop, 12-18
isreleasewu, 20-6
tdtransfer, 12-20
isstandby, 20-3
tdunsetup, 12-23
isstandbywu, 20-4
CORBA Service commands
odinspect, 20-7
CosNaming_s, 14-2
tdrelease, 20-9
InterfaceRep_Cache_e, 14-7
tdreleasewu, 20-10
InterfaceRep_Cache_s, 14-4
tdstandby, 20-11
K00stopod, 14-10
tdstandbywu, 20-12
OD_impl_inst, 14-11
cmdspcert, 11-2
OD_kill, 14-22
cmentcert, 11-3
OD_or_adm, 14-23
cmentcrl, 11-4
OD_set_env, 14-33
cmenterkey, 11-5
OD_stop, 14-35
cmentpfx, 11-6
odadmin, 14-40
cmgetcrl, 11-8
odadmin_ex, 14-43
cmlistcert, 11-9
odcntlque, 14-46
cmlistcrl, 11-11
odlistir, 14-49
cmmakecsr, 11-12
odlistns, 14-53
cmmkenv, 11-14
odsethost, 14-56
cmmkpfx, 11-15
odsetque, 14-58
cmrmcert, 11-17
S99startod, 14-36
cmsetenv, 11-17
CosNaming_s, 14-2
commands
Database Linkage Service commands
InfoProvider Pro, 10-1
otsalive, 13-2
Servlet Service, 4-1
otsmklog, 13-4
Component Transaction Service commands
otsmonitor, 13-7
tdadddef, 12-2
otspendlist, 13-10
tddeldef, 12-4
otssetrsc, 13-14
tdinfobj, 12-5
otssetup, 13-19
Index-2
Reference Manual (Command Edition) - Index
otsstart, 13-21
ejbmakecontainer, 5-4
otsstartrsc, 13-22
ejbsetssleb, 11-19
otsstop, 13-24
ejbuninstalleb, 5-10
otsstoprsc, 13-26
ejbunsetssleb, 11-20
otstranlist, 13-28
esbackupsys, 22-3
Directory Service Linkage commands
esdump, 23-4
tdresetaso, 19-2
eslogdump, 23-5
tdsetauthmanager, 19-3
esmkchnl, 11-21, 16-3
EJB Service commands
esmkunit, 16-8
ejbdbdefexport, 5-32
esmonitor, 16-14
ejbdbdefimport, 5-34
esmonitorchnl, 16-16
ejbdcustx, 5-25
esrestoresys, 22-5
ejbdefexport, 5-27
esrmchnl, 16-44
ejbdefimport, 5-30
esrmunit, 16-45
ejbdelcontainer, 5-5
essecmode, 16-19
ejbdstarteb, 5-12
essetcnf, 16-21
ejbdstopeb, 5-15
essetcnfchnl, 16-26
ejbinfoapfolder, 5-17
essetup, 11-21, 16-30
ejbinfocontainer, 5-22
esstart, 16-32
ejbinstalleb, 5-7
esstartchnl, 16-33
ejbmakeapfolder, 5-2
esstartfctry, 16-34
ejbmakecontainer, 5-4
esstartunit, 16-35
ejbuninstalleb, 5-10
esstop, 16-36
ejbcustx, 5-25
esstopchnl, 16-38
ejbdbdefexport, 5-32
esstopfctry, 16-40
ejbdbdefimport, 5-34
esstopunit, 16-42
ejbdefexport, 5-27
esunsetup, 16-46
ejbdefimport, 5-30
Event Service commands
ejbdelcontainer, 5-5
esmkchnl, 16-3
ejbdstarteb, 5-12
esmkunit, 16-8
ejbdstopeb, 5-15
esmonitor, 16-14
ejbinfoapfolder, 5-17
esmonitorchnl, 16-16
ejbinfocontainer, 5-22
esrmchnl, 16-44
ejbinstalleb, 5-7
esrmunit, 16-45
ejbmakeapfolder, 5-2
essecmode, 16-19
Index-3
Reference Manual (Command Edition) - Index
essetcnf, 16-21
apachectl, 9-2
essetcnfchnl, 16-26
htpasswd, 9-4
essetup, 16-30
ihsrlog, 9-6
esstart, 16-32
Interstage Operation Tool commands
esstartchnl, 16-33
interstage, 2-7
esstartfctry, 16-34
isstartoptool, 2-2
esstartunit, 16-35
isstopoptool, 2-3
esstop, 16-36
S99FJSVwgui, 2-9
esstopchnl, 16-38
ippadpasswd, 10-3
esstopfctry, 16-40
ippbackup, 22-11
esstopunit, 16-42
ippdisp, 10-5
esunsetup, 16-46
ippregistupin, 11-23
fjj2eeadmin, 6-2
ipprestart, 10-10
htpasswd, 9-4
ipprestore, 22-13
IDLc, 21-2
ippsetstartup, 10-13
ihsregistupin, 11-22
ippstart, 10-15
ihsrlog, 9-6
ippstartsv, 10-17
ijsbackup, 22-7
ippstop, 10-18
ijsdeployment, 3-2
ippstopsv, 10-20
ijslistapl, 3-7
irdelete, 22-15
ijsrestore, 22-9
irlogdump, 23-7
ijsundeployment, 3-5
isaddtarget, B-2
InfoProvider Pro commands, 10-1
isaddwudef, 15-2
ippadpasswd, 10-3
iscbackupsys, 22-17
ippdisp, 10-5
iscollectinfo, 23-2
ipprestart, 10-10
iscreatesys, 1-2
ippsetstartup, 10-13
iscrestoresys, 22-19
ippstart, 10-15
isdeletesys, 1-3
ippstartsv, 10-17
isdeletetarget, B-3
ippstop, 10-18
isdelwudef, 15-3
ippstopsv, 10-20
isdisplaysmm, B-4
InterfaceRep_Cache_e, 14-7
isgendef, 1-4
InterfaceRep_Cache_s, 14-4
isgetstatus, 20-2
interstage command, 2-7
isguibackup, 22-21
Interstage HTTP Server commands
isguirestore, 22-24
Index-4
Reference Manual (Command Edition) - Index
isinfobj, 15-13
isstopsmm, B-10
isinfwudef, 15-11
isstopsmma, B-15
isinit, 1-8
isstopwu, 15-8
islistobj, 15-18
isunsetsmm, B-16
islistsys, 1-14
isunsetsmma, B-17
islistwu, 15-4
J2EE operation commands
islistwudef, 15-10
ijsdeployment, 3-2
ismodifyservice, 1-15
ijslistapl, 3-7
ispdeleteenv, 18-5
ijsundeployment, 3-5
ispmakeenv, 18-2
j2eebackup, 22-31
ispreport, 18-12
j2eejndisetup, 6-12
ispsetagt, 18-19
j2eerestore, 22-32
ispstart, 18-6
JMS commands
ispstatus, 18-9
jmschmod, 7-19
ispstop, 18-8
jmsinfods, 7-16
ispunsetagt, 18-20
jmsinfodst, 7-13
isregistdef, 1-22
jmsinfofact, 7-7
isrelease, 20-5
jmsmkdst, 7-9
isreleasewu, 20-6
jmsmkfact, 7-3
isresetretrycount, 15-12
jmsrmds, 7-15
isresetservice, 1-21
jmsrmdst, 7-12
issetsmm, B-6
jmsrmfact, 7-6
issetsmma, B-8
jmssetupcluster, 7-17
issoapbackup, 22-27
jmsbackup, 22-33
issoaprestore, 22-29
jmschmod, 7-19
isstandby, 20-3
jmsinfods, 7-16
isstandbywu, 20-4
jmsinfodst, 7-13
isstart, 1-25
jmsinfofact, 7-7
isstartoptool, 2-2
jmsmkdst, 7-9
isstartsmm, B-11
jmsmkfact, 7-3
isstartsmma, B-13
jmsrestore, 22-35
isstartwu, 15-6
jmsrmds, 7-15
isstat, 1-28
jmsrmdst, 7-12
isstop, 1-32
jmsrmfact, 7-6
isstopoptool, 2-3
jmssetupcluster, 7-17
Index-5
Reference Manual (Command Edition) - Index
JNDI commands
OD_or_adm, 14-23
fjj2eeadmin, 6-2
OD_set_env, 14-33
j2eejndisetup, 6-12
OD_stop, 14-35
jssrs_ clean, 4-5
odadmin, 14-40
jssrs_start, 4-2
odadmin_ex, 14-43
jssrs_stop, 4-4
odadministerlb, A-2
K00stopod, 14-10
odbackupsys, 22-41
Load, A-7
odcntlque, 14-46
Load Balancing commands
odcvttrace, 23-9
odadministerlb, A-2
oddisplaylbobj, A-4
oddisplaylbobj, A-4
odexportir, 22-42
odnotifydown, A-6
odexportns, 22-45
odsetlbo, A-8
odformsnap, 23-10
odstartlbo, A-10
odformtrace, 23-12
odstoplbo, A-11
odfreesnap, 23-14
Maintenance, 23-2, 23-4, 23-5, 23-7
odimportir, 22-48
Maintenance commands
odimportns, 22-51
odcvttrace, 23-9
odinspect, 20-7
odformsnap, 23-10
odlistir, 14-49
odformtrace, 23-12
odlistns, 14-53
odfreesnap, 23-14
odnotifydown, A-6
odprtcurparam, 23-15
odnotifyrecover, A-7
odprthdrtrace, 23-17
odprtcurparam, 23-15
odstartsnap, 23-18
odprthdrtrace, 23-17
odstopsnap, 23-20
odrestoresys, 22-55
otsgetdump, 23-22
odsethost, 14-56
tdalllog, 23-28
odsetlbo, A-8
makeslot, 11-25
odsetpath, 11-32
maketoken, 11-26
odsetque, 14-58
mkslt, 11-27
odsetSSL, 11-30
mktkn, 11-28
odstartlbo, A-10
obfbkup, 22-37
odstartsnap, 23-18
obfrestore, 22-39
odstoplbo, A-11
OD_impl_inst, 14-11
odstopsnap, 23-20
OD_kill, 14-22
otsalive, 13-2
Index-6
Reference Manual (Command Edition) - Index
otsbackupsys, 22-58
isdeletetarget, B-3
otsgetdump, 23-22
isdisplaysmm, B-4
otslinkrsc, 21-21
issetsmm, B-6
otsmklog, 13-4
issetsmma, B-8
otsmkxapgm, 21-25
isunsetsmm, B-16
otsmonitor, 13-7
isunsetsmma, B-17
otspendlist, 13-10
Servlet Service commands, 4-1
otsrestoresys, 22-59
jssrs_ clean, 4-5
otssetrsc, 13-14
jssrs_start, 4-2
otssetup, 13-19
jssrs_stop, 4-4
otsstart, 13-21
setup commands
otsstartrsc, 13-22
iscreatesys, 1-2
otsstop, 13-24
isdeletesys, 1-3
otsstoprsc, 13-26
isgendef, 1-4
otstranlist, 13-28
isinit, 1-8
Performance Analysis Monitoring commands
islistsys, 1-14
ispdeleteenv, 18-5
ismodifyservice, 1-15
ispmakeenv, 18-2
isregistdef, 1-22
ispreport, 18-12
isresetservice, 1-21
ispsetagt, 18-19
SOAP Service operation commands
ispstart, 18-6
soapcldeploy, 8-69
ispstatus, 18-9
soapdd2wsdd, 8-9
ispstop, 18-8
soapgwaddclgw, 8-16
ispunsetagt, 18-20
soapgwdelclgw, 8-19
porbeditenv, 17-2
soapgwlistclgw, 8-21
Portable-ORB commands
soapgwstartclgw, 8-12
porbeditenv, 17-2
soapgwstopclgw, 8-14
S99FJSVwgui, 2-9
soapidl2wsdl, 8-24
S99startod, 14-36
soapmodifydd, 8-2
scsdelete, 11-41
soapsecdecconf, 8-55
scsenter, 11-39
soapsecencconf, 8-51
scslistcrl, 11-42
soapsecrelconf, 8-59
scsmakeenv, 11-33
soapsecsignconf, 8-43
Server Machine Monitor Agent commands
soapsecverifyconf, 8-47
isaddtarget, B-2
soapwsdl2idl, 8-39
Index-7
Reference Manual (Command Edition) - Index
soapcldeploy, 8-69
tdlinknormapm, 12-11
soapdd2wsdd, 8-9
tdlistobj, 12-13, 12-14
soapgwaddclgw, 8-16
tdlistwu, 15-28
soapgwdelclgw, 8-19
tdlistwusnap, 15-29
soapgwlistclgw, 8-21
tdmodifyprocnum, 15-32
soapgwstartclgw, 8-12
tdmodifywu, 15-30
soapgwstopclgw, 8-14
tdrelease, 20-9
soapidl2wsdl, 8-24
tdreleasewu, 20-10
soapMngSSL, 11-50
tdresetaso, 19-2
soapmodifydd, 8-2
tdrestoresys, 22-62
soapsecdecconf, 8-55
tdsetauthmanager, 19-3
soapsecencconf, 8-51
tdsetup, 12-16
soapsecrelconf, 8-59
tdstandby, 20-11
soapsecsignconf, 8-43
tdstandbywu, 20-12
soapsecverifyconf, 8-47
tdstart, 12-17
soapSetSSL, 11-43
tdstartsnap, 15-34
soapwsdl2idl, 8-39
tdstartwu, 15-35
start/stop commands
tdstop, 12-18
isstart, 1-25
tdstopsnap, 15-37
isstartsmm, B-11
tdstopwu, 15-38
isstartsmma, B-13
tdtransfer, 12-20
isstat, 1-28
tdunsetup, 12-23
isstop, 1-32
WorkUnit management commands
isstopsmm, B-10
isaddwudef, 15-2
isstopsmma, B-15
isdelwudef, 15-3
tdadddef, 12-2
isinfobj, 15-13
tdalllog, 23-28
isinfwudef, 15-11
tdbackupsys, 22-60
islistobj, 15-18
tdc, 21-32
islistwu, 15-4
tddeldef, 12-4
islistwudef, 15-10
tdformsnap, 15-26
isresetretrycount, 15-12
tdfreesnap, 15-27
isstartwu, 15-6
tdinfobj, 12-5
isstopwu, 15-8
tdinhibitobj, 12-7
tdformsnap, 15-26
tdlinkapm, 12-8
tdfreesnap, 15-27
Index-8
Reference Manual (Command Edition) - Index
tdlistwu, 15-28
tdlistwusnap, 15-29
tdmodifyprocnum, 15-32
tdmodifywu, 15-30
tdstartsnap, 15-34
tdstartwu, 15-35
tdstopsnap, 15-37
tdstopwu, 15-38
Index-9
Reference Manual (Command Edition) - Index
Index-10
Download PDF
Similar pages