DECnet-Plus, DCL Commands
*Conan The Librarian (sorry for the slow response - running on an old VAX)
|
VMS Help DECnet-Plus, DCL Commands *Conan The Librarian (sorry for the slow response - running on an old VAX) |
|
The following DCL commands provide enhanced capabilities if you have
installed DECnet-Plus.
| 1 - APPEND |
The APPEND/APPLICATION_PROTOCOL=FTAM command accesses the FTAM
appending utility, which appends files between FTAM systems within
an OSI network. The appending utility operates on a combination of
local and remote FTAM or on remote files only. Using this command,
you can:
o Append an input file to a single output file
o Concatenate two or more input files into a single output file
If only local files are specified, the APPEND/APPLICATION_
PROTOCOL=FTAM utility passes the command to the RMS appending
utility. In that case, all command qualifiers operate in the
standard manner documented in OpenVMS help.
1.1 - Format
APPEND/APPLICATION_PROTOCOL=FTAM [/qualifier(s)] input-file-spec
[,...] output-file-spec
The following table describes the variables in this format state-
ment:
__________________________________________________________________
Variable Explanation
__________________________________________________________________
/qualifier An RMS qualifier of the APPEND command. For a
full description of supported qualifiers, see
individual qualifier subtopics; for a summary,
see the "Qualifier" subtopic.
input-file-spec A file specification of an input (source) file,
which can be either local or remote.
[,...] A file list containing file specifications for
one or more additional input files. Within a file
list, you must precede each additional file spec-
ification with either a comma (,) or a plus sign
(+) with or without a space. To end an input file
list, either omit the comma or plus sign between
the last input file specification and the output
file specification or press <RET>.
Input files can be from the same or different
FTAM systems.
output-file- The name of an output file. Because FTAM
spec always creates only one output file, the
APPEND/APPLICATION_PROTOCOL=FTAM command ac-
cepts only one output-file specification.
For local output files, appending a file to a
local directory is controlled by the same rules
that control the RMS appending utility. If you
specify no directory, the utility places the
output file in your default directory. If you
specify another local directory for which you
have write privileges, the utility places the
output file in that directory.
For remote output files, always specify the file
designation. For information on where a remote
FTAM system places an output file that is created
remotely using FTAM, see the documentation of the
remote system.
__________________________________________________________________
1.2 - Wildcards
Wildcards provide a method for generalizing a file designation to
encompass a set of local files. Standard DCL wildcard techniques
work for both local (RMS) files and remote files for those remote
FTAM systems that support the NBS-9 document type. If using
wildcard techniques with remote FTAM systems does not work, you
should complete the file designation.
The supported wildcard characters include an asterisk (*) to
represent a text string, a percent sign (%) to represent a single
character, or empty brackets ([ ]) to represent all files in the
local default RMS directory.
1.3 - Qualifiers
The availability of APPEND command qualifiers for the
APPEND/APPLICATION_PROTOCOL=FTAM command varies for local and
remote files. For local FTAM (RMS) files, the FTAM append utility
supports most of the DCL APPEND command qualifiers. For remote
files, only a few of those qualifiers are supported.
For APPEND command qualifiers used with local files, the FTAM ap-
pending utility generally implements standard RMS default values
and actions. The exceptions are indicated by the term "nonstan-
dard" in the qualifier descriptions.
Any APPEND command qualifier that is unlisted here is accepted as
a null qualifier, which produces no effect on the outcome of the
APPEND command.
1. 3.1 - /ALLOCATION
/ALLOCATION
/ALLOCATION=n
Qualifier type: Output file qualifier
Supported file Local and remote
types:
This qualifier sets the initial allocation for the output file to
the number of 512-byte blocks specified by n.
Default value: Size of input file
1. 3.2 - /BACKUP
/BACKUP
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to the dates of their most
recent backup. It is relevant only with /BEFORE or /SINCE and is
incompatible with /CREATED, /EXPIRED, and /MODIFIED.
Default value: Creation date
1. 3.3 - /BEFORE
/BEFORE
/BEFORE=time
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only those files that are dated before
the time specified using absolute time (a specific date and/or
time or a keyword - TODAY, TOMORROW, or YESTERDAY) or combination
time (absolute plus delta time). Associated qualifiers: /BACKUP,
/CREATED, /EXPIRED, or /MODIFIED. For information on specifying
absolute and delta time, see the "OpenVMS User's Manual".
Default value: Today
1. 3.4 - /BY_OWNER
/BY_OWNER
/BY_OWNER=uic
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only files whose user identification code
(UIC) matches the specified UIC.
Default value: UIC of current process
1. 3.5 - /CHARACTER_SET
/CHARACTER_SET=
This qualifier specifies which character set the file data belongs
to, and instructs FTAM to encode the data accordingly. For example,
to copy file data of the Japanese character sets Kanji and Katakana,
the user must supply the CHARACTER_SET= qualifier with the value
JP_INTAP2.
Default value: No character set specified
1. 3.6 - /CONFIRM
/CONFIRM
/NOCONFIRM
Qualifier type: Input file qualifier
Supported file types: Local and remote
This qualifier controls whether a request is issued before each
append operation asking you to indicate whether to append that
file. The local sytem prompts you by asking: "Append filename?
[N]." Issue one of the following responses:
o To affirm appending a specific file: Yes, True, or 1
o To prevent appending a specific file: No, FALSE, 0, or <RET>
o To continue appending without further confirmations: ALL
o To stop all appending: Quit or <CTRL/Z>
Abbreviations and any combination of upper- and lowercase letters
are acceptable.
Default value: Unconfirmed
1. 3.7 - /CONTIGUOUS
/CONTIGUOUS
/NOCONTIGUOUS
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier indicates whether the output file must occupy
consecutive physical disk blocks.
Default value: Noncontiguous storage (nonstandard default)
1. 3.8 - /CREATED
/CREATED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files based on their dates of creation. It
is relevant only with /BEFORE or /SINCE and is incompatible with
/BACKUP, /EXPIRED, and /MODIFIED.
Default value: Creation date
1. 3.9 - /EXCLUDE
/EXCLUDE=(file[,...])
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier excludes from appending a file whose file specifi-
cation matches any excluded file specification. When excluding a
single file, you can omit the parentheses. Device names and ver-
sion numbers are unsupported. Using wildcards for file name and
type is permitted.
Default value: All input files are copied
1. 3.10 - /EXPIRED
/EXPIRED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to their scheduled expi-
ration dates. It is relevant only with /BEFORE or /SINCE and is
incompatible with /BACKUP, /CREATED, and /MODIFIED.
Default value: Creation date
1. 3.11 - /EXTENSION
/EXTENSION=n
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier specifies the number of blocks to be added to the
output file each time the file is extended. If you do not specify
/EXTENSION, the default extension attribute of the output file is
determined by the extension attribute of the corresponding input
file.
Default value: The default extension for the local system
- usually 3 (nonstandard default)
1. 3.12 - /JOURNAL
/JOURNAL=(filename )
Qualifier type: Global qualifier
Supported file Local (RMS) files
types:
This qualifier controls whether you want the FTAM service provider
to negotiate recovery and restart with the peer FTAM entity (if it
supports recovery). When the /JOURNAL qualifier is present, then
the FTAM protocol machine will insert checkpoints within the data
and will maintain a docket that contains recovery-related
information.
If an error occurs during data transfer, and the image has not
exited, the FTAM protocol machine will attempt to recover from the
error, using the checkpoints.
Default action: No journaling
1. 3.13 - /LOG
/LOG
/NOLOG
Qualifier type: Global qualifier
Supported file types: Local and remote
This qualifier controls whether the FTAM appending utility dis-
plays the input and output file specifications of each local file
it appends. The /LOG qualifier displays following information:
o The file specifications of the input and output files
o The number of blocks or records appended
o The total number of new files created
Default value: No logging
1. 3.14 - /MODIFIED
/MODIFIED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to the dates on which they
were last modified. It is relevant only with /BEFORE or /SINCE and
is incompatible with /BACKUP, /CREATED, and /EXPIRED.
Default value: Creation date
1. 3.15 - /NEW_VERSION
/NEW_VERSION
Qualifier type: Output file qualifier
Supported file Local (RMS) and remote files
types:
This qualifier controls whether the FTAM appending facility cre-
ates a new output file if the specified output file does not ex-
ist. If the specified output file does exist, the /NEW_VERSION
qualifier is ignored and the input file is appended to the output
file.
Default date: /NONEW_VERSION
1. 3.16 - /PARAMETER=CONCURRENCY_CONTROL
/PARAMETER=CONCURRENCY_CONTROL=(parameter: value)
Qualifier type: Global qualifier
Supported file Remote files
types:
This qualifier gives users the ability to specify the file-locking
parameters and values that are defined in ISO standard 8571. The
possible file-locking parameters are:
o READ
o INSERT
o REPLACE
o EXTEND
o ERASE
o READ_ATTRIBUTE
o CHANGE_ATTRIBUTE
o DELETE_FILE
The allowed values for these file-locking parameters are:
o not-required
o shared
o exclusive OR
o no-access
Default action: No concurrency_control is used
1. 3.17 - /PARAMETER=CREATE_PASSWORD
/PARAMETER=CREATE_PASSWORD=(password)
Qualifier type: Global qualifier
Supported file Local (RMS) and remote files
types:
This qualifier gives users the ability to pass a password value,
if the responding FTAM entity (an FTAM listener) requires a pass-
word in order for anyone to create a file on its file system. This
file system password is not the same as a password for logging
into an account.
Default action: No create_password used
1. 3.18 - /PARAMETER=SECURITY
/PARAMETER=SECURITY=(ACTION=(ACCESS-REQUEST[,ACCESS-REQUEST...]),
[CONCURRENCY=(CA-NAME:CA-KEY[,CA-NAME:CA-KEY...])],
[PASSWORD=(APWD-NAME:APWD-STRING[,APWD-NAME:APWD-STRING...])],
[IDENTITY=USER-IDENTITY-STRING],
[LEGAL=LEGAL-QUAL-STRING])
This qualifier allows the user to implement FTAM security group
functions. These functions only apply for local to remote, or
remote to remote file copying.
The string list specified on the command line must be enclosed within
single or double quotes. All white space appearing within these
quotes is ignored.
The entire security string must be enclosed within parentheses, and
multiple entries within the parenthesis must be separated by commas.
You can abbreviate parameter values as long as there are
enough characters for a unique value.
You can use a dash (-) to continue any portion of the security group
specification onto a new line.
You can specify more than one security group, however you must
flag each new group list element with its own /PARAMETER=SECURITY
qualifier. Note that the legal qualification parameter can only be
specified once.
The ACTION=(ACCESS-REQUEST) is mandatory. CONCURRENCY, PASSWORD,
IDENTITY, and LEGAL are optional.
The allowed values for ACCESS-REQUEST, CA-NAME, and APWD-NAME
are READ, INSERT, REPLACE, EXTEND, ERASE CHANGE-ATTRIBUTE,
READ-ATTRIBUTE, and DELETE-FILE.
The allowed values for CA-KEY are NOT-REQUIRED, SHARED, EXCLUSIVE,
and NO-ACCESS.
The expected input for APWD-STRING, USER-IDENTITY, and
LEGAL-QUAL-STRING is GraphicString.
Default action: No security is used
1. 3.19 - /PROTECTION
/PROTECTION=(code)
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier defines the protection to be applied to the output
file.
Default value: The default protection of the OpenVMS user
process (nonstandard default)
1. 3.20 - /SINCE
/SINCE=time
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only those files that are dated after
the time specified using absolute time (a specific date and/or
time or a keyword - TODAY, TOMORROW, or YESTERDAY) or combination
time (absolute plus delta time). Associated qualifiers: /BACKUP,
/CREATED, /EXPIRED, or /MODIFIED. For information on specifying
absolute and delta time, see the "OpenVMS User's Manual".
Default value: Today
1.4 - Examples
1. $ APPEND/APPLICATION=FTAM TEST.DAT AMIGUITA::"\DIR\FILE" <RET>
This command appends the single local file TEST.DAT to
\DIR\FILE on AMIGUITA.
Note that without the double quotation marks (" ") surrounding
\DIR\FILE, RMS would generate the following error:
%APPEND-F-OPENIN, error opening AMIGUITA::\DIR\FILE as input
-RMS-F-SYN, file specification syntax error
2. $ APPEND/APPLICATION_PROTOCOL=FTAM TEST.DAT AMIGUITA::* <RET>
This command appends the single local file TEST.DAT to TEST.DAT
on AMIGUITA.
3. $ APPEND/APPLICATION_PRO=FTAM TEST.DAT LESAMIES::"test.dat" <RET>
This command appends the single local file TEST.DAT to test.dat
on LESAMIES. Since the output-file designation is enclosed in
double quotation-marks ("-"), the lower case characters entered
in the command are retained in the output-file designation sent
to the remote FTAM system.
4. $ APPEND/APPLICATION_PROTOCOL=FTAM *.DAT FREUNDE::NEWFILE <RET>
This command concatenates alphabetically the .DAT files in the
local default directory. Concatenation ceases if any file dif-
fers in file organization, record format, or record attributes
from those of the first .DAT file listed in the directory.
Note that the specified output-file designation, NEWFILE, lacks
locational information. Therefore, the responding FTAM applica-
tion places the file NEWFILE in whatever location serves as its
default location for files created by an FTAM process.
5. $ APPEND/APPLICATION_PROTOCOL=FTAM AMIGUITA::"/DIR/FILE" <RET>
_To: AMIGUITA::"/NEWMAIN/FILE" <RET>
This command appends the file /DIR/FILE on AMIGUITA to
/NEWMAIN/FILE on the same system. Two remote systems could
just as easily be involved. Note that the file passes through
the local FTAM system but is not opened or stored locally.
6. $ APPEND/APPLICATION_PROTOCOL=FTAM -
_$ FREUNDE::"^VOL>MAIN>FILE.EXT", TEST.DAT <RET>
_To: LARGETEST.DAT <RET>
This command concatenates the remote input file,
^VOL>MAIN>FILE.EXT and the local input file, TEST.DAT,
(assuming that they have a common file organization and data
type) into the local output file, LARGETEST.DAT.
Note that without the double quotation marks (" ") surround-
ing ^VOL>DIR>FILE.EXT, DCL would interpret ^ as a parameter
delimiter and generate the following error:
%DCL-W-PARMDEL, invalid parameter delimiter ...
\^VOL\
7. $ APPEND/APPLICATION_PROTOCOL=FTAM TEST.DAT -
_$ AMIGUITA::"/MAIN/SUB/TEST/DAT" /ALLOCATION=90 <RET>
This command sets the future file size of /MAIN/SUB/TEST/DAT to
90 blocks.
Note that without the double quotation marks (" ") surrounding
/MAIN/SUB/FILE, DCL would interpret /MAIN as a qualifier and
generate the following error:
%DCL-W-IVQUAL, unrecognized qualifier ...
\MAIN\
| 2 - COPY |
The COPY/APPLICATION_PROTOCOL=FTAM command accesses the FTAM
copying utility, which copies files between FTAM systems within
an OSI network. The copying utility operates on a combination of
local and remote FTAM or on remote files only. Using this command,
you can:
o Copy an input file to an output file
o Concatenate two or more input files into a single output file
If only local files are specified, the COPY/APPLICATION_
PROTOCOL=FTAM utility passes the command to the RMS copying util-
ity. In that case, all command qualifiers operate in the standard
manner documented in OpenVMS help.
2.1 - Format
COPY/APPLICATION_PROTOCOL=FTAM [/qualifier(s)] input-file-spec
[,...] output-file-spec
The following table describes the variables in this format state-
ment:
__________________________________________________________________
Variable Explanation
__________________________________________________________________
/qualifier An RMS qualifier of the COPY command. For a
full description of supported qualifiers, see
individual qualifier subtopics; for a summary,
see the "Qualifier" subtopic.
input-file-spec A file specification of an input (source) file,
which can be either local or remote.
[,...] A file list containing file specifications for
one or more additional input files. Within a file
list, you must precede each additional file spec-
ification with either a comma (,) or a plus sign
(+) with or without a space. To end an input file
list, either omit the comma or plus sign between
the last input file specification and the output
file specification or press <RET>.
Input files can be from the same or different
FTAM systems.
output-file- The name of an output file. Because FTAM
spec always creates only one output file, the
COPY/APPLICATION_PROTOCOL=FTAM command accepts
only one output-file specification.
For local output files, copying a file to a local
directory is controlled by the same rules that
control the RMS copying utility. If you specify
no directory, the utility places the output file
in your default directory. If you specify another
local directory for which you have write privi-
leges, the utility places the output file in that
directory.
For remote output files, always specify the file
designation. For information on where a remote
FTAM system places an output file that is created
remotely using FTAM, see the documentation of the
remote system.
__________________________________________________________________
2.2 - Wildcards
Wildcards provide a method for generalizing a file designation to
encompass a set of local files. Standard DCL wildcard techniques
work for both local (RMS) files and remote files for those remote
FTAM systems that support the NBS-9 document type. If using
wildcard techniques with remote FTAM systems does not work, you
should complete the file designation.
The supported wildcard characters include an asterisk (*) to
represent a text string, a percent sign (%) to represent a single
character, or empty brackets ([ ]) to represent all files in the
local default RMS directory.
2.3 - Third-party-copying
The COPY/APPLICATION_PROTOCOL=FTAM utility supports copying a file
from one FTAM application to another by using the local OpenVMS
system as an intermediary (third-party copying). However, all
constraints for files affect both input and output files, and use
of wildcards or multiple file specifications is not possible.
2.4 - Qualifiers
The availability of COPY command qualifiers for the COPY/APPLICATION_
PROTOCOL=FTAM command varies for local and remote files. For local
FTAM (RMS) files, the FTAM copy utility supports most of the DCL
COPY command qualifiers. For remote files, only a few of those
qualifiers are supported.
For COPY command qualifiers used with local files, the FTAM copy-
ing utility generally implements standard RMS default values and
actions. The exceptions are indicated by the term "nonstandard" in
the qualifier descriptions.
Any COPY command qualifier that is unlisted here is accepted as
a null qualifier, which produces no effect on the outcome of the
COPY command.
2. 4.1 - /ALLOCATION
/ALLOCATION
/ALLOCATION=n
Qualifier type: Output file qualifier
Supported file Local and remote
types:
This qualifier sets the initial allocation for the output file to
the number of 512-byte blocks specified by n.
Default value: Size of input file
2. 4.2 - /BACKUP
/BACKUP
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to the dates of their most
recent backup. It is relevant only with /BEFORE or /SINCE and is
incompatible with /CREATED, /EXPIRED, and /MODIFIED.
Default value: Creation date
2. 4.3 - /BEFORE
/BEFORE
/BEFORE=time
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only those files that are dated before
the time specified using absolute time (a specific date and/or
time or a keyword - TODAY, TOMORROW, or YESTERDAY) or combination
time (absolute plus delta time). Associated qualifiers: /BACKUP,
/CREATED, /EXPIRED, or /MODIFIED. For information on specifying
absolute and delta time, see the "OpenVMS User's Manual".
Default value: Today
2. 4.4 - /BY_OWNER
/BY_OWNER
/BY_OWNER=uic
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only files whose user identification code
(UIC) matches the specified UIC.
Default value: UIC of current process
2. 4.5 - /CHARACTER_SET
/CHARACTER_SET=
This qualifier specifies which character set the file data belongs
to, and instructs FTAM to encode the data accordingly. For example,
to copy file data of the Japanese character sets Kanji and Katakana,
the user must supply the CHARACTER_SET= qualifier with the value
JP_INTAP2.
Default value: No character set specified
2. 4.6 - /CONCATENATE
/CONCATENATE
/NOCONCATENATE
Qualifier type: qualifier
Supported file Local (RMS) (/CONCATENATE only) and remote files
types:
This qualifier controls whether multiple input files create corre-
sponding multiple output files or create a single output file
containing the concatenated contents of all the input files.
Concatenation, which is the default, involves combining multi-
ple input files (in their input order) into a single output file.
For concatenation, all the input files must have identical file
organization, record format, and record attributes. Creating mul-
tiple output files, which requires local input files, requires the
/NOCONCATENATE qualifier.
Default action: /CONCATENATE; The output file bears the name of
the first input file.
2. 4.7 - /CONFIRM
/CONFIRM
/NOCONFIRM
Qualifier type: Input file qualifier
Supported file types: Local and remote
This qualifier controls whether a request is issued before each
copy operation asking you to indicate whether to copy that file.
The local sytem prompts you by asking: "Copy filename? [N]." Issue
one of the following responses:
o To affirm copying a specific file: Yes, True, or 1
o To prevent copying a specific file: No, FALSE, 0, or <RET>
o To continue copying without further confirmations: ALL
o To stop all copying: Quit or <CTRL/Z>
Abbreviations and any combination of upper- and lowercase letters
are acceptable.
Default value: Unconfirmed
2. 4.8 - /CONTIGUOUS
/CONTIGUOUS
/NOCONTIGUOUS
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier indicates whether the output file must occupy
consecutive physical disk blocks
Default value: Noncontiguous storage (nonstandard default)
2. 4.9 - /CREATED
/CREATED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files based on their dates of creation. It
is relevant only with /BEFORE or /SINCE and is incompatible with
/BACKUP, /EXPIRED, and /MODIFIED.
Default value: Creation date
2. 4.10 - /DELETE
Qualifier type: Global qualifier
Use of the /DELETE qualifier causes FTAM to delete the
source file after the source file has been copied to the
destination. Note that this qualifier is NOT positional, and
that it always applies to the source file, regardless its
location on the command line.
Examples:
$ copy/application_protocol=ftam/delete mydata.dat -
remote_system::remote_file.dat
mydata.dat is copied to the alias remote_system as a file name
remote_file.dat. After the copy operation is complete, FTAM
deletes the local file named mydata.dat.
$ copy/application_protocol=ftam/delete remote_system::remote_file.dat -
mydata.dat
remote_file.dat is copied from the alias remote_system to a local
file named mydata.dat. After the copy operation is complete, FTAM
deletes the remote file named remote_file.dat.
2. 4.11 - /EXCLUDE
/EXCLUDE=(file[,...])
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier excludes from copying a file whose file specifi-
cation matches any excluded file specification. When excluding a
single file, you can omit the parentheses. Device names and ver-
sion numbers are unsupported. Using wildcards for file name and
type is permitted.
Default value: All input files are copied
2. 4.12 - /EXPIRED
/EXPIRED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to their scheduled expi-
ration dates. It is relevant only with /BEFORE or /SINCE and is
incompatible with /BACKUP, /CREATED, and /MODIFIED.
Default value: Creation date
2. 4.13 - /EXTENSION
/EXTENSION=n
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier specifies the number of blocks to be added to the
output file each time the file is extended. If you do not specify
/EXTENSION, the default extension attribute of the output file is
determined by the extension attribute of the corresponding input
file.
Default value: The default extension for the local system
- usually 3 (nonstandard default)
2. 4.14 - /JOURNAL
/JOURNAL=(filename )
Qualifier type: Global qualifier
Supported file Local (RMS) files
types:
This qualifier controls whether you want the FTAM service
provider to negotiate recovery and restart with the peer FTAM
entity (if it supports recovery). When the /JOURNAL qualifier is
present, then the FTAM protocol machine will insert checkpoints
within the data and will maintain a docket that contains recovery-
related information.
If an error occurs during data transfer, and the image has not
exited, the FTAM protocol machine will attempt to recover from the
error, using the checkpoints.
Default action: No journaling
2. 4.15 - /LOG
/LOG
/NOLOG
Qualifier type: Global qualifier
Supported file types: Local and remote
This qualifier controls whether the FTAM copying utility displays
the input and output file specifications of each local file it
copies. The /LOG qualifier displays following information:
o The file specifications of the input and output files
o The number of blocks or records copied
o The total number of new files created.
Default value: No logging
2. 4.16 - /MODIFIED
/MODIFIED
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects files according to the dates on which they
were last modified. It is relevant only with /BEFORE or /SINCE and
is incompatible with /BACKUP, /CREATED, and /EXPIRED.
Default value: Creation date
2. 4.17 - /PARAMETER=CONCURRENCY_CONTROL
/PARAMETER=CONCURRENCY_CONTROL=(parameter: value)
Qualifier type: Global qualifier
Supported file Remote files
types:
This qualifier gives users the ability to specify the file-locking
parameters and values that are defined in ISO standard 8571. The
possible file-locking parameters are:
o READ
o INSERT
o REPLACE
o EXTEND
o ERASE
o READ_ATTRIBUTE
o CHANGE_ATTRIBUTE
o DELETE_FILE
The allowed values for these file-locking parameters are:
o not-required
o shared
o exclusive OR
o no-access
Default action: No concurrency_control is used
2. 4.18 - /PARAMETER=CREATE_PASSWORD
/PARAMETER=CREATE_PASSWORD=(password)
Qualifier type: Global qualifier
Supported file Local (RMS) and remote files
types:
This qualifier gives users the ability to pass a password value,
if the responding FTAM entity (an FTAM listener) requires a pass-
word in order for anyone to create a file on its file system. This
file system password is not the same as a password for logging
into an account.
Default action: No create_password used
2. 4.19 - /PARAMETER=SECURITY
/PARAMETER=SECURITY=(ACTION=(ACCESS-REQUEST[,ACCESS-REQUEST...]),
[CONCURRENCY=(CA-NAME:CA-KEY[,CA-NAME:CA-KEY...])],
[PASSWORD=(APWD-NAME:APWD-STRING[,APWD-NAME:APWD-STRING...])],
[IDENTITY=USER-IDENTITY-STRING],
[LEGAL=LEGAL-QUAL-STRING])
This qualifier allows the user to implement FTAM security group
functions. These functions only apply for local to remote, or
remote to remote file copying.
The string list specified on the command line must be enclosed within
single or double quotes. All white space appearing within these
quotes is ignored.
The entire security string must be enclosed within parentheses, and
multiple entries within the parenthesis must be separated by commas.
You can abbreviate parameter values as long as there are
enough characters for a unique value.
You can use a dash (-) to continue any portion of the security group
specification onto a new line.
You can specify more than one security group, however you must
flag each new group list element with its own /PARAMETER=SECURITY
qualifier. Note that the legal qualification parameter can only be
specified once.
The ACTION=(ACCESS-REQUEST) is mandatory. CONCURRENCY, PASSWORD,
IDENTITY, and LEGAL are optional.
The allowed values for ACCESS-REQUEST, CA-NAME, and APWD-NAME
are READ, INSERT, REPLACE, EXTEND, ERASE CHANGE-ATTRIBUTE,
READ-ATTRIBUTE, and DELETE-FILE.
The allowed values for CA-KEY are NOT-REQUIRED, SHARED, EXCLUSIVE,
and NO-ACCESS.
The expected input for APWD-STRING, USER-IDENTITY, and
LEGAL-QUAL-STRING is GraphicString.
Default action: No security is used
2. 4.20 - /PROTECTION
/PROTECTION=(code)
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier defines the protection to be applied to the output
file.
Default value: The default protection of the OpenVMS user
process (nonstandard default)
2. 4.21 - /REPLACE
/REPLACE
/NOREPLACE
Qualifier type: Output file qualifier
Supported file types: Local and remote
This qualifier determines how the copy operation responds when the
file specification requested for the output file currently belongs
to a preexisting file. On an OpenVMS system, the /REPLACE qualifier
is meaningful only when the output file specification contains
a version number. In this situation, the /NOREPLACE qualifier
generates an error condition and the output file is not created;
the /REPLACE qualifier deletes the preexisting file and copies the
input file to the preexisting file specification. The FTAM copying
utility allocates new space for the output file.
NOTE
To ensure success of the /REPLACE qualifier, use the exact
file specification that is returned by the DIRECTORY/APPLICATION_
PROTOCOL=FTAM command for the output file.
Default value: No replacement
2. 4.22 - /SINCE
/SINCE=time
Qualifier type: Input file qualifier
Supported file types: Local
This qualifier selects only those files that are dated after
the time specified using absolute time (a specific date and/or
time or a keyword - TODAY, TOMORROW, or YESTERDAY) or combination
time (absolute plus delta time). Associated qualifiers: /BACKUP,
/CREATED, /EXPIRED, or /MODIFIED. For information on specifying
absolute and delta time, see the "OpenVMS User's Manual".
Default value: Today
2. 4.23 - /VOLUME
/VOLUME=n
Qualifier type: Output file qualifier
Supported file types: Local
This qualifier directs an entire output file to a specified rela-
tive volume number (n) of a multivolume set
Default value: File takes arbitrary position within multi-
volume set
2.5 - Examples
1. $ COPY/APPLICATION_PROT=FTAM TEST.DAT AMIGUITA::"\DIR\FILE" <RET>
This command copies the single local file TEST.DAT to \DIR\FILE
on AMIGUITA.
Note that without the double quotation marks (" ") surrounding
\DIR\FILE, RMS would generate the following error:
%COPY-F-OPENIN, error opening AMIGUITA::\DIR\FILE as input
-RMS-F-SYN, file specification syntax error
2. $ COPY/APPLICATION_PROTOCOL=FTAM TEST.DAT AMIGUITA::* <RET>
This command copies the single local file TEST.DAT to TEST.DAT
on AMIGUITA.
3. $ COPY/APPLICATION_PROTO=FTAM TEST.DAT LESAMIES::"test.dat" <RET>
This command copies the single local file TEST.DAT to test.dat
on LESAMIES. Since the output-file designation is enclosed in
double quotation-marks ("-"), the lower case characters entered
in the command are retained in the output-file designation sent
to the remote FTAM system.
4. $ COPY/APPLICATION_PROTOCOL=FTAM *.DAT FREUNDE::NEWFILE <RET>
This command concatenates alphabetically the .DAT files in the
local default directory. Concatenation ceases if any file dif-
fers in file organization, record format, or record attributes
from those of the first .DAT file listed in the directory.
Note that the specified output-file designation, NEWFILE, lacks
locational information. Therefore, the responding FTAM applica-
tion places the file NEWFILE in whatever location serves as its
default location for files created by an FTAM process.
5. $ COPY/APPLICATION_PROTOCOL=FTAM MITRA::FILE.DAT [MAIN.SUB] <RET>
This command copies the remote file FILE.DAT to the local
RMS directory [MAIN.SUB]. The resulting file specification
is [MAIN.SUB]FILE.DAT.
6. $ COPY/APPLICATION_PROTOCOL=FTAM AMIGUITA::"/DIR/FILE" <RET>
_To: AMIGUITA::"/NEWMAIN/FILE" <RET>
This command copies the file /DIR/FILE on AMIGUITA to
/NEWMAIN/FILE on the same system. Two remote systems could
just as easily be involved. Note that the file passes through
the local FTAM system but is not opened or stored locally.
7. $ COPY/APPLICATION=FTAM FREUNDE::"^VOL>MAIN>FILE.EXT",TEST.DAT -
_$ LARGETEST.DAT <RET>
This command concatenates the remote input file,
^VOL>MAIN>FILE.EXT, and the local input file, TEST.DAT,
(assuming that they have a common file organization and data
type) into the local output file, LARGETEST.DAT.
Note that without the double quotation marks (" ") surround-
ing ^VOL>DIR>FILE.EXT, DCL would interpret ^ as a parameter
delimiter and generate the following error:
%DCL-W-PARMDEL, invalid parameter delimiter ...
\^VOL\
8. $ COPY/APPLICATION_PROTOCOL=FTAM TEST.DAT -
_$ AMIGUITA::"/MAIN/SUB/TEST/DAT"/ALLOCATION=90 <RET>
This command sets the future file size of /MAIN/SUB/TEST/DAT to
90 blocks.
Note that without the double quotation marks (" ") surrounding
/MAIN/SUB/FILE, DCL would interpret /MAIN as a qualifier and
generate the following error:
%DCL-W-IVQUAL, unrecognized qualifier ...
\MAIN\
9. $ COPY/APPLICATION_PROTOCOL=FTAM /CONFIRM PUNGYO::FILE.DAT <RET>
_To: FILE.DAT <RET>
Copy PUNGYO::FILE.DAT? [N] Y<RET>
After the command is confirmed, it copies the file FILE.DAT
from the system PUNGYO to the local system.
10. $ COPY/APPLICATION_PROTO=FTAM /EXCLUDE=(*.DIR,*.LOG) [...] <RET>
_To: PUNGYO::"MAIN/SUB/FILE.EXT" <RET>
This command concatenates all files in the local default di-
rectory except those having the extensions .DIR or .LOG. The
output file is a remote file MAIN/SUB/FILE.EXT on the remote
FTAM system PUNGYO.
11. $ COPY/APPLICATION_PROTOCOL=FTAM /REPLACE <RET>
_From: AMIGUITA::"/MAIN/SUB/FILE/EXT" <RET>
_To: FILE.DAT;5 <RET>
This command causes the contents of a remote file,
/MAIN/SUB/FILE/EXT from the remote FTAM system AMIGUITA, to
replace the contents of a local file, FILE.DAT;5. The local
file retains the original file name, FILE.DAT;5.
| 3 - DELETE |
The DELETE/APPLICATION_PROTOCOL=FTAM command accesses the FTAM
deletion utility, which allows you to delete one or more files
to which you have delete access on any FTAM system within an OSI
network.
3.1 - Format
DELETE/APPLICATION_PROTOCOL=FTAM [/qualifier(s)] file-spec[,...]
The following table describes the variables in this format state-
ment:
__________________________________________________________________
Variable Explanation
__________________________________________________________________
/qualifier An RMS qualifier of the DELETE command. For a full
description of supported qualifiers, see individ-
ual qualifier subtopics; for a summary, see the
"Qualifier" subtopic.
file-spec A file specification for a local or remote file.
[,...] One or more additional local or remote file specifica-
tions, each of which is separated from the preceding
file specification by either a comma (,) or a plus
sign (+).
__________________________________________________________________
3.2 - Wildcards
Wildcards provide a method for generalizing a file designation to
encompass a set of local files. Standard DCL wildcard techniques
work for both local (RMS) files and remote files for those remote
FTAM systems that support the NBS-9 document type. If using
wildcard techniques with remote FTAM systems does not work, you
should complete the file designation.
The supported wildcard characters include an asterisk (*) to
represent a text string, a percent sign (%) to represent a single
character, or empty brackets ([ ]) to represent all files in the
local default RMS directory.
3.3 - Qualifiers
Any DELETE command qualifier that is unlisted here is accepted as
a null qualifier, which produces no effect on the outcome of the
DELETE/APPLICATION_PROTOCOL=FTAM command.
3. 3.1 - /CONFIRM
/CONFIRM
/NOCONFIRM
This qualifier controls whether a request is issued before each
delete operation asking you to indicate whether to delete that
file. The local sytem prompts you by asking, "Delete filename?
[N]."
Issue one of the following responses:
o To affirm deleting a specific file: Yes, True, or 1
o To prevent deleting a specific file: No, FALSE, 0, or <RET>
o To continue deleting without further confirmations: ALL
o To stop all deleting: Quit or <CTRL/Z>
Abbreviations and any combination of upper- and lowercase letters
are acceptable.
Default value: Unconfirmed
3. 3.2 - /LOG
/LOG
/NOLOG
This qualifier controls whether the FTAM deletion utility displays
the file specification of each file it deletes.
Default value: No logging
3.4 - Examples
1. $ DELETE/APPLICATION_PROTOCOL=FTAM /CONFIRM -
_$ AMIGUITA::"/MAIN/SUB/FILE/EXT" <RET>
Delete AMIGUITA::"/MAIN/SUB/FILE/EXT"? [N] <RET>
This command allows you to review your deletion request(s)
before they are executed. In this example, confirmation is
denied and the file is undeleted.
2. $ DELETE/APPLICATION_PROTOCOL=FTAM /CONFIRM /LOG -
_$ FREUNDE::"^VOL>MAIN>FILE", TEST.DAT;4 <RET>
Delete FREUNDE::"^VOL>MAIN>FILE.EXT"? [N] Y<RET>
%DELETE-I-FILDEL, FREUNDE::"^VOL>MAIN>FILE" deleted (1 block)
Delete TEST.DAT;4? [N] N<RET>
This command requests conformation about deleting the command
deletes the remote file ^VOL>MAIN>TEST.DAT on FREUNDE and,
receiving a positive response (Y), deletes that file. The
command then requests conformation about deleting the local
file TEST.DAT;4 and, receiving a negative response (N), leaves
that file intact.
| 4 - DIRECTORY |
The DIRECTORY/APPLICATION_PROTOCOL=FTAM command accesses the FTAM
directory utility, which allows you to display the file attributes
of files on any FTAM system within an OSI network.
By default, the DIRECTORY/APPLICATION_PROTOCOL=FTAM command dis-
plays the file name and remote FTAM application address. To display
information on all of the FTAM file attributes, include the
/FULL qualifier in the DIRECTORY command.
4.1 - Format
DIRECTORY/APPLICATION_PROTOCOL=FTAM [/qualifier(s)] file-spec
[,...]
The following table describes the variables in this format state-
ment:
__________________________________________________________________
Variable Explanation
__________________________________________________________________
/qualifier An RMS qualifier of the DIRECTORY command. For a
full description of supported qualifiers, see in-
dividual qualifier subtopics; for a summary, see the
"Qualifier" subtopic.
file-spec The file specification for a local or remote file.
__________________________________________________________________
4.2 - Wildcards
Wildcards provide a method for generalizing a file designation to
encompass a set of local files. Standard DCL wildcard techniques
work for both local (RMS) files and remote files for those remote
FTAM systems that support the NBS-9 document type. If using
wildcard techniques with remote FTAM systems does not work, you
should complete the file designation.
The supported wildcard characters include an asterisk (*) to
represent a text string, a percent sign (%) to represent a single
character, or empty brackets ([ ]) to represent all files in the
local default RMS directory.
4.3 - Qualifiers
Any DIRECTORY command qualifier that is unlisted here is accepted
as a null qualifier, which produces no effect on the outcome of
the DIRECTORY/APPLICATION_PROTOCOL=FTAM command.
4. 3.1 - /BRIEF
/BRIEF
Produces a brief directory display, which is the default format.
Unless you specify the /SIZE, /OWNER, and/or /DATE qualifiers, the
brief directory display contains only and FTAM application address
and file designation for each specified file.
Default value: A brief display
4. 3.2 - /COLUMNS
/COLUMNS[=n]
Controls the number of columns in a brief directory display. In
practice, a display contains as many of the specified number of
columns as can fit within the display width or the screen width
(whichever is narrowest).
Default value: A four column display
4. 3.3 - /DATE
/DATE[=type]
/NODATE
Displays either the creation or modification date of the speci-
fied file(s) according to the type of date that you specify. The
available types of dates and their effects are:
CREATED Displays the creation date of a file (default)
MODIFIED Displays the last modification date of a file, that is,
when it was last written to
Default value: No date displayed
4. 3.4 - /FULL
/FULL
This qualifier generates a complete listing of supported file
attributes. The "File_attributes" subtopic of the /APPLICATION_
PROTOCOL=FTAM qualifier defines the attributes that are listed by
the full directory display.
Default value: A brief directory display
4. 3.5 - /GRAND_TOTAL
/GRAND_TOTAL
Suppresses both individual file listings and individual directory
totals when multiple directories are involved. The /GRAND_TOTAL
qualifier displays the total numbers of targeted directories and
files.
Default value: Both attributes of individual files and directory
totals displayed
4. 3.6 - /HEADING
/HEADING
/NOHEADING
Controls whether a heading line consisting of an FTAM application
name is displayed separately from file designations. Each FTAM
system specified in a DIRECTORY command generates a separate
directory header.
Default value: Header displayed
4. 3.7 - /OUTPUT
/OUTPUT
/OUTPUT=file
/NOOUTPUT
This qualifier controls where the output of the command is sent.
The /NOOUTPUT qualifier suppresses output. The /OUTPUT=file quali-
fier with a file name and type sends the output to the designated
file. The /OUTPUT=file with a directory but without a file name
or type sends the output to the designated directory and a file
called DIRECTORY.LIS. Using wildcards is prohibited in the /OUTPUT
file specification.
Default value: Output to the default output stream or device
of the current process, whose logical name is
SYS$OUTPUT
(Without a file specification, the /OUTPUT quali-
fier also directs output to SYS$OUTPUT.)
4. 3.8 - /OWNER
/OWNER
/NOOWNER
Controls whether the file owner's UIC is listed.
Default value: File owner undisplayed
4. 3.9 - /PRINTER
/PRINTER
This qualifier places the directory output into the file
DIRECTORY.LIS or the file you specify using the /OUTPUT=file qual-
ifier, automatically queues the file for printing, and deletes the
file.
Default value: No printing
4. 3.10 - /SIZE
/SIZE[=type]
/NOSIZE
Provides the file size in the blocks used and/or allocated for
each specified file. The available /SIZE options and their effects
are:
ALL Displays the file size both in blocks used and blocks
allocated
ALLOCATION Displays the file size in blocks allocated
USED Displays the file size in blocks used (default op-
tion)
See also the /WIDTH=(SIZE=n) qualifier.
Default value: File sizes undisplayed
4. 3.11 - /TOTAL
/TOTAL
Suppresses individual file listings and displays only the summary
information that is described under the /TRAILING qualifier.
Default value: Information about individual file(s) precedes
totals.
4. 3.12 - /TRAILING
/TRAILING
/NOTRAILING
Controls whether summary information (totals) appears in a trail-
ing line at the end of a directory display. Totals include some or
all of the following:
o Number of files listed per directory
o The number of directories (if the command specifies multiple
directories)
o Total number of blocks from each directory (if the command
contains the /SIZE or the /FULL qualifier)
Default value: Totals displayed
4. 3.13 - /WIDTH
/WIDTH[=(options[s])]
Allows you to control the display width allotted to four elements:
the entire display, file name, owner information, and file size.
If you specify only one display-element option (option), you can
omit the parentheses. The display-element options are as follows:
DISPLAY[=n] Controls the total width for a directory display.
You can make the width from 1 through 255 charac-
ters. However, if the total width of the display
exceeds the terminal width, the directory facility
truncates the display on the right side.
FILENAME[=n] Controls the width of the file-name field for a
brief directory display.
OWNER[=n] Controls the width of the owner field for a brief
directory display. If the owner information exceeds
the length of the owner field, the directory facil-
ity truncates the owner information on the right
side.
SIZE[=n] Controls the width of the size field for a brief
directory display.
Default o Display: Terminal width
value:
o File name: 19 characters
o Owner: 20 characters
o Size: 6 characters
4.4 - Examples
1. $ DIRECTORY/APPLICATION_PROTO=FTAM AMIGUITA::"\DIR\FILE\EXT", -
_$ HAVA::TEST.DAT <RET>
First, this command displays the FTAM application address,
AMIGUITA, and the file name \DIR\FILE\EXT. Next, this com-
mand displays the FTAM application address, HAVA, and the file
name TEST.DAT. The output would resemble the following:
Directory AMIGUITA::
\DIR\FILE\EXT
Total of 1 file
Directory HAVA::
TEST.DAT
Total of 1 file
2. $ DIRECTORY/APPLICATION_PROTOCOL=FTAM /FULL HAVA::TEST.DAT <RET>
This command produces a full directory display for the remote
file HAVA::TEST.DAT. The full directory display for such a
remote file would resemble the following:
Directory HAVA::
TEST.DAT File ID: None
Size: 11/12 Owner: <Unknown>
Created: <None specified> Revised: 30-JAN-1988 9:41
Expires: <None specified> Backup: <No backup done>
File organization: Sequential
File attributes: Allocation: 12, Extend: 0, Global
buffer count: 0
No version limit
Record format: Undefined
Record attributes: None
Journaling enabled: None
File protection: System: , Owner: , Group: , World:
Access Cntrl List: None
Total of 1 file, 11/12 blocks.
| 5 - RENAME |
The RENAME/APPLICATION_PROTOCOL=FTAM command accesses the FTAM
renaming utility, which allows you to rename any combination of
files to which you have access on any FTAM system within an OSI
network. You can change the directory specification, file name,
file type, or file version of an existing file.
5.1 - Format
RENAME/APPLICATION_PROTOCOL=FTAM [/qualifier(s)] input-file-
spec[,...] output-file-spec
The following table describes the variables in this format state-
ment:
__________________________________________________________________
Variable Explanation
__________________________________________________________________
/qualifier An RMS qualifier of the RENAME command. For a
full description of supported qualifiers, see
individual qualifier subtopics; for a summary,
see the "Qualifier" subtopic.
input-file-spec A file specification of an input (source) file,
which can be either local or remote.
[,...] A file list containing file specifications for
one or more additional input files. Within a file
list, you must precede each additional file spec-
ification with either a comma (,) or a plus sign
(+) with or without a space. To end an input file
list, either omit the comma or plus sign between
the last input file specification and the output
file specification or press <RET>.
Input files can be from the same or different
FTAM systems.
output-file- The name of an output file. Because FTAM
spec always creates only one output file, the
RENAME/APPLICATION_PROTOCOL=FTAM command ac-
cepts only one output-file specification.
For local output files, renaming a file to a
local directory is controlled by the same rules
that control the RMS renaming utility. If you
specify no directory, the utility places the
output file in your default directory. If you
specify another local directory for which you
have write privileges, the utility places the
output file in that directory.
For remote output files, always specify the file
designation. For information on where a remote
FTAM system places an output file that is created
remotely using FTAM, see the documentation of the
remote system.
__________________________________________________________________
5.2 - Wildcards
Wildcards provide a method for generalizing a file designation to
encompass a set of local files. Standard DCL wildcard techniques
work for both local (RMS) files and remote files for those remote
FTAM systems that support the NBS-9 document type. If using
wildcard techniques with remote FTAM systems does not work, you
should complete the file designation.
The supported wildcard characters include an asterisk (*) to
represent a text string, a percent sign (%) to represent a single
character, or empty brackets ([ ]) to represent all files in the
local default RMS directory.
5.3 - Qualifiers
Any RENAME command qualifier that is unlisted here is not sup-
ported.
5. 3.1 - /CONFIRM
/CONFIRM
/NOCONFIRM
This qualifier controls whether a request is issued before each
rename operation asking you to indicate whether to rename that
file. The local sytem prompts you by asking, "filename -> filename
? (Y,N,Q,All):."
Issue one of the following responses:
o To affirm renaming a specific file: Yes, True, or 1
o To prevent renaming a specific file: No, FALSE, 0, or <RET>
o To continue renaming without further confirmations: ALL
o To stop all renaming: Quit or <CTRL/Z>
Abbreviations and any combination of upper- and lowercase letters
are acceptable.
Default value: Unconfirmed
5. 3.2 - /LOG
/LOG
/NOLOG
This qualifier controls whether the FTAM renaming utility displays
the file specification of each file it renames.
Default value: No logging
5.4 - Examples
1. $ RENAME/APPLICATION_PROTOCOL=FTAM /CONFIRM -
_$ AMIGO::"/MAIN/SUB/FILE/EXT" AMIGO::"NEW/FILE" <RET>
AMIGO::"/MAIN/SUB/FILE/EXT" --> AMIGO::"NEW/FILE" ? (Y,N,Q,All):
Y<RET>
This command allows you to review your renaming request(s)
before they are executed. In this example, the remote file
/MAIN/FILE/EXT is renamed to the remote file /NEW/FILE on the
same system after the positive response (Y) is received.
2. $ RENAME/APPL=FTAM /CONFIRM /LOG FREUND::"^VOL>MAIN>FILE" -
_$ TEST.DAT <RET>
FREUND::"^VOL>MAIN>FILE.EXT" --> TEST.DAT ? (Y,N,Q,All): Y<RET>
%RENAME-I-RENAMED, FREUND::"^VOL>MAIN>FILE" renamed to TEST.DAT
This command requests conformation about renaming the remote
file ^VOL>MAIN>TEST.DAT on FREUND and, receiving a positive
response (Y), renames that file to TEST.DAT. The informational
message is displayed because the /LOG qualifier is used.
| 6 - SET |
DECnet-Plus for OpenVMS provides additional functionality for the
HOST option of the SET verb.
6.1 - Set Options
These are the SET command options supplied by DECnet-Plus for
OpenVMS:
Option Function
HOST/MOP Connects your terminal to a remote system
by way of the current host processor using
the MOP protocol.
HOST/VTP Connects your terminal to a remote system
by way of the current host processor using
the OSI Virtual Terminal protocol.
HOST/X29 Connects your terminal to a remote system
by way of the current host processor using
the X.25 software and the CCITT X.29
protocols.
6.2 - HOST
Connects your terminal (through the current host processor) to
another processor, called the remote processor.
Format
SET HOST remote-system
6. 2.1 - Parameter
remote-system
Specifies the name of the remote processor to which you will
connect.
6. 2.2 - /MOP
Connects your system to a remote system using the MOP protocol.
Format
SET HOST/MOP client-name
6. 2. 2.1 - Parameter
CLIENT
Specifies the name of the MOP CLIENT entity which describes
the remote system that is the target of the console carrier
request. This is an optional parameter. If omitted, you
must specify the /CIRCUIT and /ADDRESS qualifiers.
6. 2. 2.2 - Qualifiers
6. 2. 2. 2.1 - /ADDRESS=lan-address
Specifies the LAN address of the remote system.
6. 2. 2. 2.2 - /BREAK=break-character
Specifies the character which is to be recognized as a request
to send a MOP Break protocol command to the remote system.
Pressing the Ctrl key and this character transmits a MOP Break
to the remote system. The default character is \.
6. 2. 2. 2.3 - /CIRCUIT=circuit-name
Specifies the name of the MOP CIRCUIT entity over which the
request should take place.
6. 2. 2. 2.4 - /DISCONNECT=disconnect-character
Specifies the character which is to be recognized as a request
to terminate the connection with the remote system. Once the
connection is established, pressing the Ctrl key and this
character terminates the connection. The default character is ].
6. 2. 2. 2.5 - /VERIFICATION=hexidecimal-digits
Specifies the service password of the remote system. A
verification has 16 hex digits. If less than 16 digits are
specified, MOP will pad with zeros on the right.
6. 2.3 - /VTP
Connects your system to a remote system utilizing the OSI Virtual
Terminal Protocol.
Format
SET HOST/VTP alias
6. 2. 3.1 - Parameter
alias
Specifies the name of the remote VT application that you wish
to connect to. This name can be an alias in the
SYS$COMMON:[SYSEXE]ISOAPPLICATIONS.DAT file, or it can be the
X.500 Distinguished Name of the remote VT application enclosed
in quotes.
6. 2. 3.2 - Qualifiers
6. 2. 3. 2.1 - /BREAK
/BREAK=break-character
Selects the break character. The break character is used to
generate a break on lines that expect a break rather than a
carriage return. To generate a break, press Ctrl/break-character.
The break character can be any ASCII character between @ and z.
You cannot select a character currently defined as either the
command character (see the description of the /COMMAND=command-
character qualifier) or the disconnect character (see the
description of the /DISCONNECT=disconnect-character qualifier).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the "at" sign (@),
the backslash (\), the right bracket (]), the circumflex (^),
the underscore (_), and the grave accent (`).
By default, the break character is the right bracket (]).
6. 2. 3. 2.2 - /COMMAND
/COMMAND=command-character
Selects the command character. The command character is used to
access VT command mode by pressing Ctrl/command-character.
The command character can be any ASCII character between @ and z.
You cannot select a character currently defined as either the
break character (see the description of the
/BREAK=break-character qualifier) or the disconnect character
(see the description of the /DISCONNECT=disconnect-character
qualifier).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the "at" sign (@),
the backslash (\), the right bracket (]), the circumflex (^),
the underscore (_), and the grave accent (`).
By default, the command character is the "at" sign (@).
6. 2. 3. 2.3 - /DISCONNECT
/DISCONNECT=disconnect-character
Selects the disconnect character. The disconnect character is
used to abnormally terminate VT association with the remote
system by pressing Ctrl/disconnect-character.
The disconnect character can be any ASCII character between @
and z. You cannot select a character currently defined as
either the break character (see the description of the
/BREAK=break-character qualifier) or the command character (see
the description of the /COMMAND=command-character qualifier).
The ASCII characters between @ and z include the alphabetic
characters in both upper and lower cases, the "at" sign (@),
the backslash (\), the right bracket (]), the circumflex (^),
the underscore (_), and the grave accent (`).
By default, the disconnect character is the "backslash" (\).
6. 2. 3. 2.4 - /LOG
/LOG[=filespec]
/NOLOG (default)
Controls whether a log file of the entire session is kept. If you
use the /LOG qualifier without the file specification, the log
information is stored in the file SETHOST_VTP.LOG.
6. 2. 3. 2.5 - /PROFILE
/PROFILE=profile-name
Specifies the Virtual Terminal profile to be used when
establishing the association. The following profiles are
currently supported:
o Generalized_Telnet (default)
o Telnet
o Transparent
o Amode_default
6. 2. 3. 2.6 - /STATISTICS
/STATISTICS
/NOSTATISTICS (default)
Provides statistics on the VT association, including CPU usage,
pagefaults, and I/O counts.
6. 2. 3.3 - Example
$ SET HOST/VTP ITALIC
Username: BROWN
Password:
Welcome to VAX/VMS Version 5.4 on node ITALIC
.
.
.
$ LOGOUT
BROWN logged out at 19-APR-1991 15:04:25.27
%VT-S-END, Control returned to local end system
In this example, the name of the local node is CASLON. This SET
HOST/VTP command connects the user terminal to the processor at
the network node named ITALIC. The remote processor then prompts
for user name and password. Use the normal login procedure to
log in to the remote processor.
6. 2.4 - /X29
Enables a connection to a host-based PAD using the X.29 protocol.
Format
SET HOST/X29 node-name
When you are first connected to the PAD, your terminal is in
data-transfer mode. You can change to PAD command mode by typing
the appropriate escape character (usually <CTRL/P>). In command
mode you can obtain further help on the PAD (by typing HELP).
6. 2. 4.1 - Qualifiers
6. 2. 4. 1.1 - /BREAK_CHARACTER=character
/NOBREAK_CHARACTER
(Default=/NOBREAK_CHARACTER)
This qualifier sets up a control character which has the same
effect as entering the BREAK command. The character must be a
single letter representing a control character. For example,
if the character is K, <CTRL/K> acts as a BREAK key.
6. 2. 4. 1.2 - /CCITT
/NOCCITT
(Default=/NOCCITT)
If you use this qualifier and do not specify a DTE address you
may only use the /LOG, /PARAMETER, /VMS_MODE, /PROFILE,
/STATISTICS and /DEFAULT_ESCAPE_CHARACTER qualifiers. PAD will
accept only CCITT commands and an A command is used to make the
call.
If you specify a DTE address, you may use any of the qualifiers.
The PAD will make the call as requested and then enter CCITT
mode.
6. 2. 4. 1.3 - /CLOSED_USER_GROUP[=string]
/NOCLOSED_USER_GROUP
(Default=/NOCLOSED_USER_GROUP)
If this qualifier is present with a value, the value refers to
the name of the closed user group, and the parameter is the
usual DTE address.
When this qualifier is without a value, the DTE address parameter
is assumed to be the name of a bilateral closed user group.
6. 2. 4. 1.4 - /DEFAULT_ESCAPE_CHARACTER=character
/NODEFAULT_ESCAPE_CHARACTER
(Default=/DEFAULT_ESCAPE_CHARACTER=P)
This qualifier changes the control character you type to go into
PAD command mode.
Use this qualifier when accessing a PAD from a console terminal
(or on some other networking product) which interprets <CTRL/P>.
Do not enter <CTRL/P> from a console terminal unless you have set
the terminal to LOCAL DISABLE with the keyswitch. The keyswitch
is on the front of the system that you are using.
If you specify /NODEFAULT_ESCAPE_CHARACTER, you go into PAD
command mode by typing multiple <CTRL/Y>s ( or the host must set
parameter 1 to a value greater than 1 ).
6. 2. 4. 1.5 - /FACILITIES=(number-list)
/NOFACILITIES
(Default=/NOFACILITIES)
This qualifier specifies a list of numbers, in the range 0 to
255, which are in the 'local facilities field' in the NCB (refer
to the X.25 Programming Reference manual for details of the NCB).
This list specifies some local facility not covered by the X.25
software. This field is not checked so the network may reject
the call if you request an invalid facility.
6. 2. 4. 1.6 - /FAST_SELECT
/NOFAST_SELECT
(Default=/NOFAST_SELECT)
This qualifier makes the call with fast select requested.
6. 2. 4. 1.7 - /LOCAL_DTE=string
/NOLOCAL_DTE
(Default=/NOLOCAL_DTE)
The digit string specifies the local DTE address to use for the
outgoing call. This qualifier is not valid if you are using
X.25 Access.
6. 2. 4. 1.8 - /LOG[=file]
/NOLOG
(Default=/NOLOG)
This qualifier sets up a log file which logs copies of all the
data sent and received by the user.
This file is by default PSIPAD.LOG and is in the user's default
directory.
You can set the log file type in the PSI$PADLOG logical name to
either NETWORK or TERMINAL (the default). NETWORK captures data
on the network side of the host-based PAD, TERMINAL captures data
as it appears on your terminal.
Using the /LOG qualifier is the same as using the SET LOG
command which assumes the default /STAMP=SENSE. The /STAMP
qualifier has no effect on the TERMINAL log file.
6. 2. 4. 1.9 - /PACKET_SIZE=number
/NOPACKET_SIZE
(Default=/NOPACKET_SIZE)
Use this qualifier to request the specified packetsize in the
call packet. Otherwise, the network default is used. The
packetsize should be between 16 and 1024 and must be a power of
2. If you request a packetsize larger than the one configured,
X.25 will use the largest size configured.
6. 2. 4. 1.10 - /PARAMETERS=(parameter-list)
/NOPARAMETERS
(Default=/NOPARAMETERS)
The parameter-list consists of compulsory keywords and optional
values such as TIMEOUT=10, NOWRAP and DELETE. This qualifier is
the same as issuing a SET PARAMETER parameter-list command.
X.25 reads the parameter-list before you make your call.
6. 2. 4. 1.11 - /PROFILE=(profile-list)
/NOPROFILE
(Default=/NOPROFILE)
This qualifier is a list of profiles. It is the same as issuing
several "SET PROFILE profile-name" commands, one for each profile
name in the list.
6. 2. 4. 1.12 - /PROTOCOL_IDENTIFIER=string
/NOPROTOCOL_IDENTIFIER
(Default=/PROTOCOL_IDENTIFIER="01")
Use this qualifier to put a non-standard X.29 protocol identifier
string into the 'protocol identifier' field of the call. The
string is interpreted as a series of hexadecimal digits which
fill the first 4 bytes of user data in the call packet. Valid
values for this string are set up by the X.29 protocol.
6. 2. 4. 1.13 - /REVERSE_CHARGING
/NOREVERSE_CHARGING
(Default=/NOREVERSE_CHARGING)
Use this qualifier to request reverse charging in the call
packet.
6. 2. 4. 1.14 - /SUBADDRESS=string
/NOSUBADDRESS
(Default=/NOSUBADDRESS)
If you use this qualifier, the digit string you specify is a
local subaddress in the outgoing call.
6. 2. 4. 1.15 - /STATISTICS
/NOSTATISTICS
(Default=/STATISTICS)
This qualifier displays the duration of the PAD session at the
end of the call.
6. 2. 4. 1.16 - /THRUPUT_CLASS=number
/NOTHRUPUT_CLASS
(Default=/NOTHRUPUT_CLASS)
Use this qualifier to request the specified throughput class in
the call packet.
6. 2. 4. 1.17 - /USER_DATA=string
/NOUSER_DATA
(Default=/NOUSER_DATA)
Use this qualifier to specify a string of user data that is sent
to the remote DTE when the call is established. The maximum size
of the string is 12 characters, unless /FAST_SELECT has been
specified, in which case it is 124 characters.
6. 2. 4. 1.18 - /VMS_MODE
/NOVMS_MODE
(Default=/NOVMS_MODE)
This qualifier causes the PAD to enter VMS mode.
This optimizes communication with the remote DTE if the system is
VMS V4.0 or later. Do not use this qualifier unless you are
connected to a VAX/VMS V4.0 or later system.
6. 2. 4. 1.19 - /WINDOW_SIZE=number
/NOWINDOW_SIZE
(Default=/NOWINDOW_SIZE)
Use this qualifier to request the specified windowsize in the
range of 1-127 in the call packet. Otherwise, the network
default is used. If you request a windowsize larger than the one
configured, X.25 will use the largest size configured.
|
|
