Hitachi

uCosminexus Application Server Command Reference Guide

ctmstartgw (start an ORB gateway)

Organization of this page

Format

ctmstartgw [-h] |
           -CTMGWID gateway-identifier
           [-CTMDomain CTM-domain-name]
           [-CTMID CTM-identifier]
           [-CTMMyHost host-name-or-IP-address]
           [-CTMEnviron user-environment-variable-definition-file-name]
           [-CTMEjbPort port-number]
           [-CTMAgent {1|0}]
           [-CTMIDLConnect [1|0]]
           [-CTMTimeOut timeout-value]
           [-CTMClientConnectCount maximum-number-of-connectable-clients]

To Page Top

Function

This command starts a gateway process that enables CTM to handle requests from the ORB client. Before you start the ORB client on a host, make sure that the CTM daemon for which a CTM regulator has been started is running on the host.

To Page Top

Arguments

-h

Displays how to use the command.

-CTMGWID gateway-identifier

Specifies the gateway identifier of the ORB gateway to be started. You can specify 1 to 32 alphanumeric characters. Specify a value that can identify only one gateway under the CTM node that is specified by using the -CTMDomain and -CTMID options.

-CTMDomain CTM-domain-name

Specifies the name of the CTM domain to which the CTM daemon belongs. You can specify 1 to 31 alphanumeric characters. Do not specify a string that begins with CTM or ctm. If no value is specified, the command assumes that CTMDOMAIN is specified.

-CTMID CTM-identifier

Specifies the CTM identifier of the CTM daemon. You can specify 1 to 31 alphanumeric characters and periods (.). Do not specify a CTM identifier that begins with CTM or ctm. You can use periods (.) only when you specify an IP address.

If no value is specified, an IP address is set as a CTM identifier. For example, if the IP address of the host is 172.17.112.43, the string 172.17.112.43 is set as a CTM identifier.

-CTMMyHost host-name-or-IP-address

Specifies the host name or IP address used by CTM in a multihomed host environment or a node-switching environment in which both nodes share the same IP address. The specified value can consist of 1 to 64 characters. If no value is specified, the command assumes that the host name acquired by the hostname command is specified.

If you specify the -CTMMyHost option without specifying the -CTMID option, the IP address specified for the -CTMMyHost option is used as the default CTM identifier.

-CTMEnviron user-environment-variable-definition-file-name

Specifies the name of the CTM user environment variable definition file that defines the environment variables used by the process to be started. The specified value must include an absolute path name.

  • Windows

    The specified value can consist of alphanumeric characters and the following symbols: . \ : + - _

  • UNIX

    The specified value can consist of alphanumeric characters and the following symbols: . / + - _

For details about the CTM user environment variable definition file, see 7.2.1 CTM user environment variable definition file in the manual uCosminexus Application Server Definition Reference Guide.

-CTMEjbPort port-number

Specifies the port number that the ORB client uses when searching for a new connection to the ORB gateway. You can specify an integer in the range from 5001 to 65535. If no value is specified, the port number automatically assigned by the OS is used.

-CTMAgent {1|0}

Specifies whether the CORBA objects that correspond to EJB objects are to be registered in OSAgent of TPBroker. If 1 is specified, these CORBA objects are registered in OSAgent. The default is 1. If 0 is specified, these CORBA objects are not registered in OSAgent.

Note that you can specify 0 only when you specify the -CTMIDLConnect option.

-CTMIDLConnect [1|0]

If this option is specified, an IDL-format repository ID (IDL:interface-name:1.0) is used for the CORBA object corresponding to the ORB gateway to be started. This option also specifies whether to enable connection using an IOR string.

Specify this option if the client's ORB product supports only IDL-format repository IDs.

If the argument of this option is omitted, the command assumes that 1 is specified.

If 1 is specified for this option and the ORB gateway is started, after the application has been started on the J2EE server, the IOR string for the ORB gateway can be acquired by using the ctmgetior command. The default is 1. If 0 is specified and the ORB gateway is started, no more IOR strings can be acquired. However, the application and ORB gateway can start in a shorter time than when 1 is specified.

If you specify this option, always specify also the -CTMEjbPort option. If you omit this option, specify 1 for the -CTMAgent option.

-CTMTimeOut timeout-value

Specifies the default amount of time (in seconds) to wait for a response to be returned after a service request is received from the client. You can specify an integer in the range from 0 to 2147483647. If 0 is specified, there is no limit on the wait time. If this option is omitted, 180 (seconds) is set.

-CTMClientConnectCount maximum-number-of-connectable-clients

Specifies the maximum number of connections that can be established from the ORB client to the ORB gateway. You can specify an integer in the range from 1 to 32767.

If this option is omitted, the value of the -CTMClientConnectCount option set for the CTM daemon is used. If the -CTMClientConnectCount option is also omitted, 64 is set.

To Page Top

Return values

0:

The command ended normally.

Other than 0:

The command terminated abnormally due to an error that occurred during command processing. Take measures as indicated in the message that is output, and then re-execute the command.

To Page Top

Notes

To Page Top

Trademarks

All Rights Reserved. Copyright (C) 2022, Hitachi, Ltd.