Note on usage
Function: Modify file attributes in a remote system
User group: FT user
Functional description
With ftmod you can modify the attributes of a file in a remote system. Depending on the partner (openFT, FTAM or FTP), the following file attributes can be modified:
With openFT partners:
File name
Access rights (not if the partner system is a Windows system)
With FTAM partners:
File name
Access rights (not if the partner system is a Windows system)
Availability of the file
Account for file storage costs
Legal qualification on using the file
Future file size
With FTP partners:
File name
Format
ftmod -h |
<partner 1..200>![<file name 1..512>]
[ <transfer admission 8..67> | @n | @d |
<user ID 1..67>[,[<account 1..64>][,[<password 1..64>]]] ]
[ -fnc=t | -fnc=c ]
[ -p=[<management password 1..64>] ]
[ -nf=<new file name 1..512> ]
[ -av=i | -av=d ]
[ -ac=<new account 1..64> ]
[ -fs=<future filesize 1..2**63-1> ]
[ -am=[+][r][i][p][x][e][a][c][d] | -am=@rw | -am=@ro ]
[ -lq=<legal qualification 1..80> ]
Description
-h
Displays the command syntax on the screen. Entries after the -h are ignored.
partner![file name]
Specifies for which file and on which system the attributes are to be modified.
partner
partner is the name of the partner system in the partner list or the address of the partner system. For details on address specifications, see section “Specifying partner addresses”.
file name
file name can be either absolute or relative to the remote login authorization. If the file name in the remote system has been predefined in an FT profile, it must not be specified here.
If the partner system is running openFT (BS2000), elements from PLAM libraries may also be specified here (Syntax: Library name/Element type/Element name).
transfer admission | @n | @d |
user ID[,[account][,[password]]]
In order to modify the file attributes in the remote system, you must furnish the remote system with proof of identity. For this purpose, you will need login authorization in the syntax valid for the remote system. You can specify this transfer admission
as an FTAC transfer admission if FTAC is used in the remote system,
or as a login/LOGON authorization in the syntax used by the remote system (user ID, possibly together with account or password).
For details, see section “Entering the authorization data for the partner system” .
@n for transfer admission
By entering @n you specify that the remote system requires no login authorization.
@d for transfer admission
Specifying @d (blanked transfer admission) causes openFT to query the transfer admission on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the transfer admission.
A binary password or binary transfer admission must be specified in hexadecimal format, see section “Entering commands”.
password not specified
Omitting the password necessary for admission causes openFT to query the password on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the password.
Nevertheless, you have to specify the commas, e.g.:
ftmod partner!file user-id,,
or
ftmod partner!file user-id,account,
neither transfer admission nor user ID specified
causes the same as @d, i.e. openFT queries the transfer admission on the screen after the command is entered. Your (blanked) entry is always interpreted as transfer admission and not as user ID.
-fnc=t | -fnc=c (file name coding)
specifies the encoding mode for the remote file names (file name, new file name).
t (transparent, default value)
Specification of the remote file names in transparent mode (compatible to the previous versions).
c (character)
Specification of the remote file names in character mode. The names are interpreted according to the character code of the remote system, i.e. for Unix partners according to the openFT operating parameter option (ftmodo -fnccs) that has been set there.
-fnc=c is only permitted for partners as of openFT V12.1.
-p=[management password]
If the file in the remote system is protected by a password, you must enter this password here.
A binary password must be entered in hexadecimal format, see section “Entering commands”. This is of relevance for links to openFT (BS2000), because BS2000 supports the definition of hexadecimal passwords.
management password not specified
Specifying -p= causes openFT to query the password on the screen after the command is entered. Your entry is not displayed to prevent unauthorized persons from seeing the password.
-nf=new file name
This indicates the new name for the file file name in the partner system. The name file name is then no longer valid. new file name can be either absolute or relative to the remote login authorization.
-nf not specified
The file name remains unchanged.
-av=i | -av=d
Indicates the availability of the file in an FTAM partner system. This parameter can have one of two values: immediate or deferred. A file may be deferred if it has been archived, for example. The partner is responsible for interpreting the term deferred. The FTAM partner conventions must therefore be observed here.
The following values are possible:
i
In the remote system, the file attribute is set to immediate.
d
In the remote system, the file attribute is set to deferred. The file on the partner system can then be placed in an archive, for example.
Requests involving openFT or FTAM partners that do not support the storage group are rejected.
-av not specified
The previous value for availability remains unchanged.
-ac=new account
With FTAM partners, this indicates the number of the account to which file storage fees are to be charged. This parameter must be set in accordance with partner system conventions.
Requests involving openFT or FTAM partners that do not support the storage group are rejected.
-ac not specified
The previous account number remains unchanged.
-fs=future filesize
With FTAM partners, this indicates the expected file size. This is used as a guide for system-specific optimization.
Requests involving openFT or FTAM partners that do not support the storage group are rejected.
-fs not specified
The previous file size remains unchanged.
-am=[+][r][i][p][x][e][a][c][d] | @rw | @ro
This changes the access rights for a file in the remote system. Old access rights can also be replaced with new ones.
The following values can be specified for the -am parameter:
+, r, i, p, x, e, a, c, d or any combination of these values as well as @rw, or @ro.
+
with FTAM partners means that the file receives a new set of access rights in addition to the existing rights. This entry is only relevant for FTAM partners that support more than one set of access rights.
+ not specified
the existing access rights of the file in the remote system are replaced by the specified access rights.
r
means that the file can be read.
r not specified
The file cannot be read.
i
with FTAM partners means that data units, such as records, can be inserted in the file.
i not specified
No data units can be inserted in the file.
p
means that the file can be overwritten.
The file cannot be overwritten.
x
means that data can be appended to the file.
x not specified
The file cannot be extended.
e
with FTAM partners means that data units, such as records, can be deleted from the file.
e not specified
No data units can be deleted from the file.
a
means that the file attributes can be read.
a not specified
The file attributes cannot be read.
c
means that the file attributes can be changed.
c not specified
The file attributes cannot be changed.
d
means that the file can be deleted.
d not specified
The file cannot be deleted.
@rw
is the short form of the common access rights read-write (rpxeacd), and thus simplifies input.
@ro
is the short form of the common access rights read-only (rac), and thus simplifies input.
If the partner system is a Windows system, you cannot change the access rights of the destination file.
With Unix or BS2000 partner systems, only the following access rights can be set for a file:
Access | Short | Unix | BS2000 | Access rights |
rpxeacd | @rw | rw* | ACCESS=WRITE | read-write |
rac | @ro | r-* | ACCESS=READ | read-only |
pxeacd | -w* | only with BASIC-ACL (Access | write-only | |
ac | --* | only with BASIC-ACL (Access | none |
Requests involving FTP partners or involving FTAM partners that do not support the security group are rejected.
-am not specified
The current access rights remain unchanged.
-lq=legal qualification
With FTAM partners, this specifies a legal qualification for the file (similar to a copyright). This may not exceed 80 characters.
Requests involving openFT or FTAM partners that do not support the security group are rejected.
-lq not specified
The current legal qualifications remain unchanged.
Example
You wish to reset the access rights of the remote file junk from read-only to read-write. The file is on the BS2000 computer bs2r1 under login name jim with account number a1234ft and password C'pwd'. The file is protected by the password abcd.
Unix systems:
ftmod bs2r1!junk jim,a1234ft,C\'pwd\' -p=C'abcd' -am=@rw
Windows systems:
ftmod bs2r1! junk jim,a1234ft,C'pwd' -p=C'abcd' -am=@rw