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.
Functional description
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 to query the following information from the remote administration server (see the section “Remote administration commands” ):
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. For details, see in the manual "openFT (Unix and Windows systems) - Installation and Operation".
Format
ftadm -h |
[ -c ]
[ -cs=<partner 1..200> ]
[ -ri=<routing info 1..200> ]
[ -fnc=t | -fnc=c ]
<command 1..8192> | -
[ <transfer admission 8..67> | @d ]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
-c
Specifies whether the user data (i.e. the command and the command output) is to be
transferred in encrypted form. It is only possible to specify -c if openFT-CR is installed.
If openFT-CR is not installed, -c is suppressed in the command syntax (-h) and a syntax
error is generated if -c is specified.
-cs=partner
Specifies the name of the remote administration server 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 section “Specifying partner addresses” .
-cs not specified
If you do not specify -cs, it is assumed that the local system, i.e. the system at which you logged on, is the remote administration server. This means that you can only omit -cs if you enter ftadm directly on the remote administration server.
-ri=routing info
Specifies the pathname of the openFT instance that you want to administer. The pathname is configured by the ADM administrator on the remote administration server and is required in order to forward the remote administration request to the openFT instance. You can get the pathname by running the command ftshwc on the remote administration server. See the section “Remote administration commands” .
-ri not specified
If you do not specify -ri, the command specified under command is executed on the remote administration server, e.g. ftshwc or ftshwatp. See section “Remote administration commands” .
-fnc=t | -fnc=c (file name coding)
specifies the encoding mode for the data transferred (administration command and result).
t (transparent, default value)
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
c (character)
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
-fnc=c is only permitted for administered instances with openFT as of V12.1.
command
The remote administration command to be executed. The maximum command length supported is 8192 characters.
- (dash) for command
The dash stands for the standard input stdin, i.e. you enter the command at the keyboard. Terminate your input by pressing:
<END> or CTRL+D ( Unix systems )
STRG+Z at the start of a line, followed by Return ( Windows systems )
If input is blanked (@d) for the transfer admission, the system first queries the transfer admission. You can then enter the command.
transfer admission | @d
FTAC transfer admission for accessing the remote administration server. Specification of the transfer admission is mandatory if you have specified -cs, and must not be specified if you have not specified -cs.
@d for transfer admission
If you specify @d (blanked), the transfer admission is queried on screen after the command has been sent. The entry you make is not displayed, in order to prevent unauthorized persons from seeing the transfer admission.
transfer admission not specified
If you do not specify an FTAC transfer admission, two possible situations arise:
If you have also specified -cs, the transfer admission is queried on screen after the ftadm command has been sent.
If you do not specify -cs, i.e. if you enter ftadm directly at the remote administration server, your user ID is used as proof that you are authorized to perform remote administration.