Client Registration utility

Registers HULFT as a Registered Client on HULFT-HUB Server.

Usage

utlhubclientreg -h hostname[:servicename] -o obsport [-u userid:passwd] 
   [-C {1 | 2 | 3}] [-H hosttype] [-r recvport] [-v version] [-k knjcode] [-j jisyear] 
   [-N Nickname] [-S {0 | 1}]


utlhubclientreg -f filename [-c {e | s | 8}]

Explanation of parameters

-h hostname[:servicename]

Host name and service name of HULFT (Mandatory)

Specifies the host name and service name of HULFT to be registered.

The host name must consist of alphanumeric characters with hyphens (-) and periods (.) of 44 bytes or less.

The service name is used by the HULFT-HUB system to identify HULFT when multiple instances of HULFT are running on a single host. Specify a unique name on the host by using alphanumeric characters of no more than 100 bytes.

If the servicename is omitted, the service name will be registered as blank.

-o obsport

Request Acknowledge Port No. (Mandatory)

Specify the Request Acknowledge Port No. that is specified in the System Environment Settings of HULFT to be registered within the range from 1 to 65535.

[-u userid:passwd]

User ID and password (Optional)

Specify the user ID and password that is required to connect to HULFT to be registered. This parameter cannot be omitted if the Password Check function is enabled in HULFT.

[-C {1 | 2 | 3}]

Client type (Optional)

Specify whether to register HULFT as a Controlled Client. Select one of the following:

1:

It is registered as a Controlled Client.

2:

It is registered as a Client Outside of Control (with Relay).

3:

It is registered as a Client Outside of Control (without Relay).

If omitted, it is registered as a Controlled Client.

[-H hosttype]

Host type (Optional)

Specify the host type of HULFT to be registered. Select one of the following:

H:

Mainframe

L:

Linux/UNIX

I:

IBMi

W:

Windows

If omitted, the information is obtained from HULFT to be registered.

However, this parameter cannot be omitted if the client type is set to '2' or '3'.

[-r recvport]

Receive Port No. (Optional)

Specify the Receive Port No. that is specified in the System Environment Settings of HULFT to be registered within the range from 1 to 65535.

If omitted, the information is obtained from HULFT to be registered.

However, this parameter cannot be omitted in either of the following cases.

  • The client type is set to '2' or '3'.

  • The host type is set to 'H', or the type of the host name specified by -h is mainframe.

[-v version]

Version information (Optional)

Specify the version information of HULFT to be registered in the format VxxLyyRzz. xx represents a version, yy represents a level, and zz represents a revision, each represented by 2 bytes. (If the version, level, or revision is only 1 byte, prefix it with 0.)

 

Specification example for Ver.8.0.0:

-v V08L00R00

 

If omitted, the information is obtained from HULFT to be registered.

However, this parameter cannot be omitted in any of the following cases:

  • The client type is set to '2' or '3'.

  • The host type is set to 'H', or the type of the host name specified by -h is mainframe.

[-k knjcode]

Kanji Code Type (Optional)

Specify the Kanji Code Type of HULFT to be registered. Select one of the following:

S:

SHIFT-JIS

J:

JEF

E:

EUC-JP

I:

IBM Kanji

K:

KEIS

N:

NEC Kanji

8:

UTF-8

G:

GB18030

C:

IBM Simplified Chinese

= Remarks =

For the Kanji code type, specify the code type used in the client when the version of HULFT to be registered is earlier than Ver. 8.1. For Ver. 8.1 and later, use the value for the field Transfer Code Set specified in the System Environment Settings file.

Specifiable Kanji Code Type depends on the host type and the version.

Table 3.7 Relationship among the host type, Kanji Code Type, and version

Host type

Kanji Code Type

Version

7.x.x

8.0.x

8.1.x

8.2.x

8.4.x

10.x

H (mainframe)

I (IBM Kanji)

Y

-

Y

Y

Y

Y

J (JEF)

Y

-

-

Y

Y

Y

K (KEIS)

-

-

-

-

-

-

N (NEC Kanji)

-

-

-

-

-

-

8 (UTF-8)

-

-

Y

Y (*1)

Y (*1)

-

L (Linux/UNIX)

S (SHIFT-JIS)

Y

Y

Y

-

Y

Y

E (EUC-JP)

Y

Y

Y

-

Y

Y

8 (UTF-8)

Y

Y

Y

-

Y

Y

G (GB18030)

-

-

Y

-

Y

Y

I (IBMi)

I (IBM Kanji)

Y

-

Y

-

Y

Y

8 (UTF-8)

-

-

Y

-

Y

-

C (IBM Simplified Chinese)

-

-

Y

-

Y

Y

W (Windows)

S (SHIFT-JIS)

Y

-

-

-

-

-

Y

:

Can be specified.

-

:

Cannot be specified.

*1

:

If the Host Type is 'H (mainframe)', only HULFT8 for zOS can specify '8 (UTF-8)' for the Kanji Code Type.

 

If omitted, the information is obtained from HULFT to be registered.

However, this parameter cannot be omitted in any of the following cases:

  • The client type is set to '2' or '3'.

[-j jisyear]

JIS Year (Optional)

If the Kanji code type to be registered in HULFT is Japanese, choose the value for the JIS Year of the Kanji code type from the following.

78:

JIS78

83:

JIS83, JIS90

If omitted, the information is obtained from HULFT to be registered.

However, this parameter cannot be omitted in any of the following cases:

  • The client type is set to '2' or '3'.

  • The host type is set to 'H', or the type of the host name specified by -h is mainframe.

[-N Nickname]

Notification Host Name (Optional)

Specify a name reported as the name of the remote host for file transfer.

The name must consist of alphanumeric characters with hyphens (-) and periods (.) of 44 bytes or less.

If omitted, the host name will not be replaced.

However, this parameter cannot be specified if the client type is set to '3'.

[-S {0 | 1}]

Forced Strong Key Mode (Optional)

Specify the Forced Strong Key Mode for the client you want to register.

0:

Disabled

1:

Enabled

You can only specify this when you specify '2' for the client type and 'V08L04R00' or later for the version information.

If you omit this specification, '0' is registered.

-f filename

Parameter file name (Mandatory)

Read information from a CSV-format parameter file to batch register multiple hosts.

For details about the format of the parameter file, see Format of the parameter file.

[-c {e | s | 8}]

Character code (Optional)

Specifies the character code of the parameter file.

e:

EUC

s:

SHIFT-JIS

8:

UTF-8

If omitted, the value specified in Kanji Code Type (KnjCode) of the System Environment Settings of HULFT-HUB Server is assumed.

Note

You can use only '-c 8' (UTF-8) in HULFT-HUB Server for Windows.

If you omit the -c parameter, the code set is automatically determined according to the Windows system locale.

Status code

0:

The utility was executed successfully.

10:

The specified options are incorrect.

11:

A termination instruction was detected.

12:

Failed to allocate memory.

13:

A system error occurred.

50:

The client is already registered.

60:

An error occurred while registering the client.

101 or above:

An SQL error occurred.

Notes on using the utilities

For details about the operation environment for using the utilities, see Notes on execution of utilities (commands).

For this utility, also note the following:

  • If you specify the Host Type, Kanji Code Type, Request Acknowledge Port No., Receive Port No., Version Information, or Forced Strong Key Mode for a Client outside of Control (with Relay), specify the correct information for the HULFT you want to register.

  • Specify a host name/service name that does not overlap with any registered client. This utility cannot be used to update the information of a registered client.

    If you specify a parameter file to register multiple hosts, and both registered and unregistered clients exist in the parameter file, only the unregistered clients will be registered.

  • Do not register a client as a controlled client in multiple HULFT-HUB system servers.

Output example

0000:0000 WIN01:v7                                                              
0000:0000 ux02x64:v7(solaris)
    1)            2)

Figure 3.7 Output example of the Management Information Synchronization utility (when a parameter file is specified)

Displayed fields

The following table lists and describes the fields shown in the output example.

Table 3.8 Displayed fields of the Client Registration utility

No.

Description

1

Status code: Detail code (See Table 3.9 )

2

Distribution destination host name: Service name (Alias)

Table 3.9 Status code and Detail code of the Client Registration utility

Status code

Detail code

Cause of the error

Measure

0001

XXXX

An error occurred while processing on HULFT.

Take measures according to "Various codes in Status codes and detail codes of hubmgrd.

0005

0006

0011

0012

0013

0014

0015

0016

0017

0018

0022

0023

8000

8001

8003

9998

Format of the parameter file

The parameter file used for batch registering multiple hosts is a CSV-format file with information on one host per line. The following fields can be set.

Table 3.10 Explanation of each field

Type

Title

Description

Default value

Assignable value

Maximum length

Specification

1

composition-title

Composition type

-

client

20

Mandatory

2

ServerName

Host name of the Controlling Server

-

(*1)

68

Optional

3

ServerServiceName

Service name of the Controlling Server

-

(*1)

100

Optional

4

HostName

Host name of the client

-

Alphanumeric characters with hyphens (-) and periods (.)

(*2)

Mandatory

5

DomainName

Domain name of the client

-

Alphanumeric characters with hyphens (-) and periods (.)

(*2)

Optional

6

HostServiceName

Service name of the client

(Blank)

Alphanumeric characters

100

Optional

7

DispName

Alias of the client

(Blank)

Characters

256

Optional

8

ManagementClient

Controlled Client

1

1

:

Controlled Client

2

:

Client Outside of Control (with Relay)

3

:

Client Outside of Control (without Relay)

1

Optional

9

HostType

Host Type

 

H

:

Mainframe

L

:

Linux/UNIX

I

:

IBMi

W

:

Windows

1

Optional

10

ProductType

Product Type

8

10

:

HULFT10

8

:

HULFT8

7

:

HULFT7

1

Optional

11

UserIdNotify

Notify about User Details

0

0

:

Do not notify

1

:

Notify

1

Optional(*6)

12

KanjiCodeType

Kanji Code Type

 

S

:

S-JIS

J

:

JEF

E

:

EUC

I

:

IBM Kanji

K

:

KEIS

N

:

NEC Kanji

8

:

UTF-8

G

:

GB18030

C

:

IBM Simplified Chinese

1

Optional(*3)

13

JISYear

JIS Year

83

78

:

JIS78

83

:

JIS83,JIS90

2

Optional(*4)

14

ReceivePortNo

Receive Port No.

30000

From 1 to 65535

5

Optional(*4)

15

OBSPortNo

Request Acknowledge Port No.

31000

From 1 to 65535

5

Mandatory

16

ReceiveOverRetry

Server Retry at Receive Multiplex Level Over

1

0

:

Do Not Retry

1

:

Retry

1

Optional

17

ConnectUserId

User ID

(Blank)

Alphanumeric characters

20

Optional

18

ConnectPassword

Password

(Blank)

Alphanumeric characters

14

Optional

19

ConnectId

Connect ID

(Blank)

Characters

16

Optional

20

Comment

Comment

(Blank)

Characters

60

Optional

21

Nickname

Notification Host Name

(Blank)

Alphanumeric characters with hyphens (-) and periods (.)

68

Optional(*5)

22

StrongkeyMode

Forced Strong Key Mode

0

0: Disabled

1: Enabled

1

Optional

(*7)

*1

:

The specification for the Controlling Server is ignored, and the client is registered to HULFT-HUB Server on which this utility is performed.

*2

:

If DomainName (the domain name of the client) is omitted, specify HostName (host name of the client) with a string of 44 bytes or less.

If DomainName (the domain name of the client) is specified, note that the total-of-host-name + '.' + domain-name must be no more than 44 bytes.

*3

:

This field cannot be omitted in the following cases:

  • ManagementClient (Controlled Client) is set to '2' or '3'.

*4

:

This field cannot be omitted in either of the following cases:

  • ManagementClient (Controlled Client) is set to '2' or '3'.

  • HostType (host type) is set to 'H', or the type of host specified by HostName (host name of the client) and DomainName (domain name of the client) is mainframe

*5

:

This field cannot be specified if ManagementClient (Controlled Client) is set to '3'.

*6

:

This item is not used because HULFT-HUB does not hold the value on the server. Specify whether to notify the user ID or not by using the parameter of the following utility every time.

  • Executing the Send File utility/Resend File utility (utlhubreqsend)

  • Delivery Instruction utility (utlhubsend)

*7

:

You can only specify this when you specify '2' for Controlled Client (ManagementClient) and '8' for Product Type (ProductType).

 

Double quotation marks (") are used as Enclosed Characters and commas (,) are used as Separators.

= Remarks =

  • Double quotation marks (") can be omitted as text enclosures.

    However, if the data includes any double quotation marks or commas (,), they cannot be omitted. Furthermore, to ensure that double quotation marks are displayed in the data as is, enter two contiguous double quotation marks ("") for each double quotation character that is to be displayed in the data.

  • The leading spaces and middle spaces of items are read as is, but trailing spaces are truncated.

"composition-title","ServerName","ServerServiceName","HostName","DomainName","Ho
stServiceName","DispName","ManagementClient","HostType","ProductType","UserIdNot
ify","KanjiCodeType","JISYear","ReceivePortNo","OBSPortNo","ReceiveOverRetry","C
onnectUserId","ConnectPassword","ConnectId","Comment","Nickname","StrongkeyMode" 
"client","","","HQ01UX","","","Head Office client","1","U","7","0","E","83","300
00","31000","1","","","","","",""
"client","","","WIN01","","","","1","W","7","0","S","83","30000","31000","1", ""
,"","","","","" 
"client","","","XYZUNX","","","XYZ client","2","U","8","0","8","83","3000 
0","31000","1","","","","","","1"

Figure 3.8 Example of a parameter file for client registration

TOP

Policies     (c) Saison Technology Co.,Ltd. 2006