Note on usage
Function: Execute remote administration command
User group: Users configured as remote administrators on the remote administration server.
A remote administration server must be deployed in order to use this command.
The command can be specified under TSO.
Description of the function
The FTADM command allows you to act as a remote administrator and administer an openFT instance via a remote administration server. The remote administration server accepts the administration request, checks the authorization and forwards the request to the openFT instance that is to be administered.
In addition, as remote administrator, you can use FTADM command to query the following information from the remote administration server (see section “Remote administrationcommands”):
You can determine what openFT instances you are authorized to administer and what remote administration permissions you have for these instances.
You can read the ADM traps that the openFT instances you are administering have sent to the remote administration server. For this to be possible, the remote administration server must also be configured as an ADM trap server for the administered openFT instances.
Format
FTADM |
PARTNER-SERVER = <text 1..200 with-low> ,TRANSFER-ADMISSION = <alphanum-name 8..32>(...) / <c-string 8..32 with-low>(...) / <x-string 15..64>(...) ,ROUTING-INFO = <text 1..200 with-low> / <c-string 1..200 with-low> / *NONE ,CMD = <c-string 1..1800 with-low> ,OUTPUT = *STDERR / *STDOUT / *FILE(...) *FILE(...) FILE-NAME = <filename 1..59> ,DATA-ENCRYPTION = *NO / *YES ,FILE-NAME-ENCODING = *TRANSPARENT / *CHARACTER |
Operands
PARTNER-SERVER= <text 1..200 with-low>
Specifies the partner name in the partner list or the address of the remote administration server. The remote administration server must be addressed as an ADM partner. For details, see the section “Specifying partner addresses”.
TRANSFER-ADMISSION =
Specifies the FTAC transfer admission for accessing the remote administration server.
ROUTING-INFO =
Contains the routing information required to forward the remote administration command from the remote administration server to the required openFT instance.
ROUTING-INFO = <text 1..200 with-low> / <c-string 1..200 with-low>
Specifies the pathname of the openFT instance that you want to administer. The pathname is configured on the remote administration server by the ADM administrator. You can get the pathname by running the command ftshwc on the remote administration server, see the manual "openFT (z/OS) - Installation and Operation".
ROUTING-INFO = *NONE
No routing information is required, i.e. the command is executed directly on the remote administration server. Only specific commands, however, (ftshwc and ftshwatp) can be executed directly on the remote administration server. You will find a brief description of these commands in section “Remote administration commands”.
CMD =
Remote administration server command in the syntax of the openFT instance to be administered. A remote administration command can only be processed if the remote system is using an FT product that supports this function (see the section “Remoteadministration commands”).
CMD = <c-string 1..1800 with-low>
The remote administration command to be executed.
OUTPUT =
Specifies where the data generated by the command should be output following transfer in the local system.
OUTPUT = *STDERR
The data is written to *STDERR.
OUTPUT = *STDOUT
The data is written to *STDOUT.
OUTPUT = *FILE(...)
The data is written to a file. Please note that only the data which the command specified with CMD outputs to *SYSLST (BS2000) or *STDOUT (on z/OS) or stdout (on a Unix/Windows system) is written to file.
FILE-NAME = <filename 1..59>
Name of the output file.
DATA-ENCRYPTION =
Specifies whether the data is to be transferred in encrypted form. The encryption of the request description data is not affected by this parameter.
DATA-ENCRYPTION = *NO
The data is transferred unencrypted.
DATA-ENCRYPTION = *YES
The data is transferred encrypted.
FILE-NAME-ENCODING =
Specifies the encoding mode for the data transferred (administration command and result).
FILE-NAME-ENCODING = *TRANSPARENT
Specification of data transfer in transparent mode (compatible to the previous versions).
The data is interpreted on the initiator system and the target system with fixed character codes:
Unix and Windows systems: ISO8859-1
BS2000 systems: EBDCDIC DF04-1
z/OS systems: IBM1047
FILE-NAME-ENCODING = *CHARACTER
Specification of data transfer in character mode.
The data is interpreted on the initiator system and the target system with the following character codes:
Unix systems inbound: Character code set via openFT operating parameter option (ftmodo -fnccs). In the ISO646 character set, the coding of this character code must match the coding of ISO8859-1.
Unix systems outbound: Character code that results from the LOCALE and LANG setting
Windows systems: UTF-8
BS2000 systems: EBDCDIC DF04-1
z/OS systems: IBM1047
FILE-NAME-ENCODING=*CHARACTER is only permitted for openFT partners as of openFT V12.1.