Job Management Partner 1/Software Distribution Client Description and User's Guide

[Contents][Glossary][Index][Back][Next]


6.4.3 Syntax of the end workstation settings file

This section explains the content to specify in an end workstation settings file.

Organization of this subsection
(1) Format
(2) Details

(1) Format

ManagingHost host-name
WorkstationType END
ProtocolKind TCP
[WatchTimeofOrders distribution-job-monitoring-interval]
[RetryCount retry-count]
[RetryInterval retry-interval]
[ServerRetryCount retry-count]
[ServerRetryInterval retry-interval]
[DeliveryRetryCount package-distribution-and-file-collection-retry-count]
[DeliveryRetryInterval package-distribution-and-file-collection-retry-interval]
[TransferDataSize {512|1024|2048|4096}]
[LifeofResource number-of-days]
[Compress {NO|COMPRESS|PACK|COMMON}]
[AutoAction {YES|NO}]
[EventType IM]
[DetailStatusInf {YES|NO}]
[SystemLogOutputLevel {0|1|2|3}]
[MaxEntryofMessage maximum-message-count-for-message-log-file]
[ReceiveWaitTime file-transfer-response-timeout]
[EnableMultiServer {YES|NO}]
[RebootPermission {YES|NO}]

(2) Details

ManagingHost host-name ~ <uppercase alphabetic characters, numerics, hyphens, underscores, or periods>((1 to 64 characters))
Specify the address of the managing server. The value specified in this attribute becomes the default if the host file is not specified in the packaging-information file or in the rdsft command option.
If the managing server is running in a cluster environment, specify a host name that is compatible with the logical IP address defined by the cluster software. For details about operations in a cluster environment, see the Job Management Partner 1/Software Distribution Manager documentation.

WorkstationType END
Specify END, which indicates an end workstation.

ProtocolKind TCP
Specify TCP as the communication protocol with the managing server. The value specified in this attribute becomes the default if the host file is not specified in the packaging-information file or in the rdsft command option.

WatchTimeofOrders package-distribution-and-file-collection-retry-count ~ <unsigned integer> ((0 to 60)) <<5>> (in minutes)
To check for the presence of a distribution job on the managing server from the end workstation, specify in minutes the time interval for monitoring the execution of the command to check for the presence of a distribution job (rdsma command).
If you execute the rdsma command when this attribute is set, the system monitors the execution of the command at the specified intervals.
If you specify 0 for this attribute, the system monitors the command only once.

RetryCount retry-count ~ <unsigned integer>((1 to 9))<<3>> (number of times)
In retry-count, specify the maximum number of times the system performs a retry if it cannot establish an association or connection with the managing server. If you specify 9, the system will retry endlessly.

RetryInterval retry-interval ~ <unsigned integer>((1 to 99))<<1>> (in units of 10 seconds)
In retry-interval, specify the interval at which the system performs a retry if it cannot establish an association or connection with the managing server. Specify a value in units of 10 seconds.

ServerRetryCount retry-count ~ <unsigned integer>((1 to 9))<<3>> (number of times)
In retry-count, specify the maximum number of times the system performs a retry if it cannot establish a connection to the file transfer server facility. If you specify 9, the system will retry endlessly.

ServerRetryInterval retry-interval ~ <unsigned integer>((1 to 99))<<5>> (in seconds)
In retry-interval, specify the interval at which the system performs a retry if it cannot establish a connection to the file transfer server facility. Specify a value in seconds.

DeliveryRetryCount package-distribution-and-file-collection-retry-count ~ <unsigned integer>((0 to 9))<<0>> (number of times)
In retry-count, specify the maximum number of times the system retries the package distribution (or file collection) command if a line failure occurs during package distribution (or file collection). If you specify 0, the system does not perform a retry.

DeliveryRetryInterval package-distribution-and-file-collection-retry-interval ~ <unsigned integer>((1 to 99))<<3>> (in units of 10 seconds)
In retry-interval, specify the interval at which the system retries the package distribution (or file collection) command if a line failure occurs during package distribution (or file collection). Specify a value in units of 10 seconds. Note that if the DeliveryRetryCount attribute is set to 0, the system ignores the DeliveryRetryInterval attribute.

TransferDataSize ~ {512 | 1024 | 2048 | 4096}<<1024>>
Specify the size of the buffer for exchanging data with the managing server in a TCP/IP environment.
Select one of the buffer sizes, considering the network environment between the end workstation and the managing server.

LifeofResource number-of-days ~ <unsigned integer>{1 to 999}<<1>>
In number-of-days, specify the number of days for storing resources. If the expiration date of a resource is not specified in the packaging-information file, the resource is stored in the temporary package storehouse for the number of days specified in this attribute. The default is one day (following registration).

Compress ~ {NO | COMPRESS | PACK | COMMON}<<NO>>
Specify the compression method for the packages you want to register.

NO
Does not compress the packages.

COMPRESS
Uses the compress command to compress the packages.

PACK
Uses the pack command to compress the packages.

COMMON
Compresses shared packages.
Specifying PACK has no effect on a package consisting of three or fewer blocks.
If compression of a package fails, the package is registered but is not compressed. The value specified in this attribute becomes the default for the packages for which the compression method is not specified in the packaging-information file.

AutoAction ~ {YES | NO}<<NO>>
Specify whether to send a JP1 event to JP1/Base if an error occurs or if the status changes.

YES
Sends a JP1 event.

NO
Does not send a JP1 event.
For details on automatic actions and other operations using JP1 events, see 8. JP1 Event Processing Using JP1/IM - Manager.

EventType IM
Specify IM as the type of JP1 event to be issued.

DetailStatusInf ~ {YES | NO}<<NO>>
Specify whether or not to report the details of the job execution status to the managing server.

YES
Reports the details of the job status.

NO
Does not send a detailed report.
When YES is specified, the job status is reported as follows on the managing server side:
  • If a distribution job that installs a package during system operations is executed, the end status of the job changes to 0x80 when transfer of the package to the distribution-destination system is completed.
  • When multiple distribution jobs are executed simultaneously, the end of execution is reported for each job.

SystemLogOutputLevel ~ {0 | 1 | 2 | 3}<<3>>
Specify the level for the messages to be output to the syslog file.

0
Does not output messages.

1
Outputs error messages and system error messages (messages whose ID ends with E or S).

2
Outputs error messages, system error messages, and warning messages (messages whose ID ends with E, S, or W).

3
Outputs all the messages to be output to syslog. The following messages are output to syslog:
  • Messages that are output if an error occurs except an error due to incorrect specification of operands in commands
  • Messages that are output during normal operations when JP1/Software Distribution is running in the background
The following table lists the messages that the client services output to syslog.
Message ID Facility Level
KDDMnnnn-E LOG_USER LOG_ERR
KDDMnnnn-S LOG_USER LOG_CRIT
KDDMnnnn-W LOG_USER LOG_WARNING
KDDMnnnn-I LOG_USER LOG_INFO

Legend:
nnnn: A four-digit number is displayed as the message code.

MaxEntryofMessage maximum-message-count-for-message-log-file ~ <unsigned integer>((300 to 99999))<<300>>
Specify the maximum number of messages that can be stored in a message log file.
If you change this value to be smaller than it was before, the message log file is edited beginning from the latest message up to the new maximum that you specified. Delete unnecessary messages and retain the necessary ones. Editing of the message log file temporarily requires additional disk space for the value you specified here. Before specifying this value, make sure that there is sufficient free space on the disk.

ReceiveWaitTime file-transfer-response-timeout ~ <unsigned integer>((0 to 2147483647))<<240>> (unit: seconds)
Specifies in seconds the time to monitor for a response from the server after a file is sent.
If there is no response from the server within the specified file transfer time, the system assumes that communication failed. If you specify 0, response is not monitored.
Make sure the value you specify here is not less than the sleep time between transmissions (FileTransferSleepTime) set in the manager services settings file; otherwise, a communication error will occur when there is a pause between transmissions.

EnableMultiServer ~ {YES|NO}<<NO>>
Specifies whether or not to accept jobs executed at multiple higher-level systems. A system configuration that has multiple higher-level systems is called a multiserver.

YES
Specify this when operating on a multiserver.
According to this specification, job execution results are sent to the host that downloaded the job, instead of to the host specified in ManagingHost. However, if a package is selected and installed, job execution results are sent to the ManagingHost.
Note that if one of the following errors occurs, the job may remain in ERROR status even after recovery from the error. If this happens, recreate the job at the managing server and then execute it.
  • A communication error occurred during communication with the relay system (except for the relay system set at ManagingHost).
  • File transfer from the managing server was interrupted.

NO
Specify this when not operating on a multiserver.
With this setting, job execution results, even those downloaded from other hosts, may be sent to ManagingHost.

RebootPermission ~ {YES | NO} <<NO>>
Specify whether or not to automatically reboot the OS when OS rebooting is specified in the package specified in the distribution job. To automatically reboot the OS in JP1/Software Distribution Client, you need to specify automatic rebooting of JP1/Software Distribution Client in the system file. See 6.9 Setting the system files.

YES
The OS is rebooted following package installation. However, the OS is not rebooted if OS rebooting is not specified in the package.

NO
The OS is not rebooted.

[Contents][Back][Next]


[Trademarks]

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