STAtus subcommand—Retrieve status information from a remote host
Purpose
Use the STAtus subcommand to retrieve current configuration information from the FTP server. This information includes the current settings of the configuration variables, which can be initialized in the FTP.DATA data set or changed using various FTP subcommands. For information about the parameters of the FTP.DATA data set, see the z/OS Communications Server: IP Configuration Reference.
Format
>>-STAtus--+------+--+---------+------------------------------->< '-name-' '-(option-' options |--+-ASAtrans---------+-----------------------------------------| +-AUTOMount--------+ +-AUTORecall-------+ +-BLKsize----------+ +-BLocks-----------+ +-BLOCKSIze--------+ +-BUfno------------+ +-CHKptint---------+ +-CONDdisp---------+ +-CYlinders--------+ +-DATAClass--------+ +-DATAKEEPALIVE----+ +-DATASetmode------+ +-DB2--------------+ +-DBSUB------------+ +-DCbdsn-----------+ +-DESt-------------+ +-Directory--------+ +-DIRECTORYMode----+ +-DSNTYPE----------+ +-DSWAITTIME-------+ +-EATTR------------+ +-ENcoding---------+ +-FIFOIOTIME-------+ +-FIFOOPENTIME-----+ +-FILEtype---------+ +-FTpkeepalive-----+ +-INactivetime-----+ +-ISPFStats--------+ +-JESENTRYLimit----+ +-JESGETBYDSN------+ +-JESJOBName-------+ +-JESLrecl---------+ +-JESOwner---------+ +-JESRecfm---------+ +-JESSTatus--------+ +-LISTLEVel--------+ +-LISTSUBdir-------+ +-LRecl------------+ +-MBDATACONN-------+ +-MBREQUIRELASTEOL-+ +-MBSENDEOL--------+ +-MGmtclass--------+ +-MIGratevol-------+ +-PDSTYPE----------+ +-PRImary----------+ +-QUOtesoverride---+ +-RDw--------------+ +-READTAPEFormat---+ +-RECfm------------+ +-RETpd------------+ +-SBDataconn-------+ +-SBSENDEOL--------+ +-SBSUB------------+ +-SBSUBChar--------+ +-SECondary--------+ +-SPRead-----------+ +-SQLCol-----------+ +-STOrclass--------+ +-TLSRFCLEVEL------+ +-TRacks-----------+ +-TRAILingblanks---+ '-TRUNcate---------' |--+-UCOUNT---------------+-------------------------------------| +-UCSHostcs------------+ +-UCSSub---------------+ +-UCSTrunc-------------+ +-UMask----------------+ +-UNICODEFILESYSTEMBOM-+ +-Unit-----------------+ +-UNIXFILETYPE---------+ +-VCOUNT---------------+ +-VOLume---------------+ +-WRAPrecord-----------+ +-WRTAPEFastio---------+ '-XLate----------------'
Parameters
- ASAtrans
- Indicates that the FTP server interprets characters in the first column of ASA files being transferred as print control characters.
- AUTOMount
- Indicates automatic mounting of volumes for data sets that are on unmounted volumes.
- AUTORecall
- Indicates automatic recall of migrated data sets.
- BLocks
- Indicates that primary and secondary space allocations are in blocks.
- BLOCKSIze
- Indicates the block size of a newly allocated data set.
- BUfno
- Indicates the number of access method buffers that are to be used when data is read from or written to a data set.
- CHKptint
- Indicates the checkpoint interval for the sending site in a file transfer request.
- CONDdisp
- Indicates the disposition of the data set if a retrieve operation for a new data set ends before all of the data is written.
- CYlinders
- Indicates that primary and secondary space allocations are in cylinders.
- DATAClass
- Indicates the SMS data class.
- DATAKEEPALIVE
- Indicates the number of seconds that TCP/IP waits while the data connection is inactive before sending a keepalive packet to the FTP client. The value 0 indicates that the DATAKEEPALIVE timer is disabled for this session. For active mode data connections, the keepalive timer that is configured in PROFILE.TCPIP controls how often keepalive packets flow on the data connection. For passive mode data connections, FTP suppresses the PROFILE.TCPIP keepalive timer.
- DATASetmode
- Indicates whether DATASetmode or DIRECTORYMode is in effect.
- DB2®
- Indicates the DB2 subsystem name.
- DBSUB
- Indicates whether substitution is allowed for data bytes that cannot be translated in a double-byte character translation.
- DCbdsn
- Indicates the name of the MVS™ data set to be used as a model for allocating new data sets.
- DESt
- Indicates the Network Job Entry (NJE) destination to which the files are routed when you enter a PUt command.
- Directory
- Indicates the number of directory blocks to be allocated for the directory of a PDS.
- DIRECTORYMode
- Indicates whether DATASetmode or DIRECTORYMode is in effect.
- DSNTYPE
- Indicates the data set name type for new physical sequential data
sets.
- SYSTEM
- The DSNTYPE value from the SMS data class is used. If no SMS data class is defined, or if it does not specify the DSNTYPE value, the system DSNTYPE value is used. This is the default value.
- BASIC
- Allocates physical sequential data sets as physical sequential basic format data sets.
- LARGE
- Allocates physical sequential data sets as physical sequential large format data sets.
- DSWAITTIME
- Indicates the number of minutes the FTP server waits for an MVS data set to become available when a local data set is held by another job or process. The value 0 indicates that the FTP server does not wait to obtain a data set when the data set is being held by another job or process.
- EATTR
- Indicates whether newly allocated data sets can have extended
attributes and whether new data sets can reside in the EAS of an EAV.
- SYSTEM
- The data set uses the SMS data class EATTR value. If no SMS data class is defined, or if the data class contains no EATTR specification, the data set is allocated with the system default.
- NO
- The data set cannot reside in the EAS, and its VTOC entry cannot contain extended attributes.
- OPT
- The data set can reside in the EAS, and its VTOC entry can have extended attributes if the volume supports them.
- ENCODING
- Indicates the encoding type that is used for conversions between code pages for data transfers.
- FIFOIOTIME
- Indicates the length of time the that FTP server waits for a read from a z/OS® UNIX named pipe or a write to a z/OS UNIX named pipe to complete.
- FIFOOPENTIME
- Indicates the length of time that the FTP server waits for an open of a z/OS UNIX named pipe to complete.
- FILEtype
- Indicates the data set file type.
- FTpkeepalive
- Indicates the control connection keepalive timer value in seconds.
- INactivetime
- Indicates the inactivity timer to a specified number of seconds.
- ISPFSTATS
- Indicates that FTP will create or update ISPF Member statistics when PUt, MPut, or APpend subcommands are issued.
- JESENTRYLimit
- Indicates the number of entries that can be displayed concurrently using a LIST or NLST command.
- JESGETBYDSN
- Indicates whether the server should retrieve the file from the MVS system and submit it as a batch job when FILETYPE is JES and JESINTERFACELEVEL is 2, or whether the server should retrieve the JES spool file by the data set name.
- JESJOBName
- Indicates that any command (Get, LIST, DIr, or MGet) should be limited to those jobs, started tasks, APPC/MVS, or TSO output that match the specified value.
- JESLrecl
- Indicates the logical record length (LRecl) for the Job Entry System (JES) internal reader at the foreign host.
- JESOwner
- Indicates that any command (Get, LIST, DIr, or MGet) should be limited to those jobs, started tasks, APPC/MVS, or TSO output which are owned by the user ID specified.
- JESRecfm
- Indicates the record format for the JES internal reader at the foreign host.
- JESSTatus
- Indicates what type of information should be returned on LIST and NLST commands.
- LISTLEVEL
- Indicates which format the FTP server will use when it replies to the LIST command.
- LISTSUBdir
- Indicates that wildcard searches should apply to the current working directory and should also span its subdirectories.
- LRecl
- Indicates the logical record length (LRecl) of a newly allocated data set.
- MBDATACONN
- Indicates the code pages for the file system and for the network transfer that are used when the server does data conversion during a data transfer.
- MBREQUIRELASTEOL
- Indicates whether the FTP server reports an error when a multibyte file or data set is received from the server with no EOL sequence in the last record received.
- MBSENDEOL
- Indicates which end-of-line sequence to use when the ENCODING value is SBCS, the data is ASCII, and data is being sent to the server.
- MGmtclass
- Indicates the SMS management class as defined for the target host by your organization.
- MIGratevol
- Indicates the volume ID for migrated data sets if they do not use IBM® storage management systems.
- PDSTYPE
- Indicates whether the FTP server creates local MVS directories as partitioned data sets or as partitioned data sets extended.
- PRImary
- Indicates the number of tracks, blocks, or cylinders for the primary allocation.
- QUOtesoverride
- Indicates that a single quotation mark at the beginning and end of a file name should override the current working directory instead of being appended to the current working directory.
- RDW
- Indicates that variable record descriptor words (RDWs) are treated as if they are part of the record and are not discarded during FTP transmission of variable format data sets in stream mode.
- READTAPEFormat
- Displays information about an input data set on tape.
- RECfm
- Displays the data set record format.
- RETpd
- Indicates the number of days that a newly allocated data set should be retained.
- SBDataconn
- Indicates the conversions between file system and network code pages to be used for data transfers.
- SBSENDEOL
- Indicates which end-of-line sequence to use when ENCODING is SBCS, the data is ASCII, and data is being sent to the client.
- SBSUB
- Indicates that substitution is allowed for data bytes that cannot be translated in a single-byte-character translation.
- SBSUBCHAR
- Indicates the value that is used for substitution when SBSUB is also specified.
- SECondary
- Indicates the number of tracks, blocks, or cylinders for the secondary allocation.
- SECUREIMPlicitzos
- Indicates that when the client connects using the TLSPORT implicit connection, the client waits for the 220 good morning reply before initiating the security handshake and negotiation.
- SPRead
- Indicates that the output is in spreadsheet format when the file type is SQL.
- SQLCol
- Indicates the SQL output file column headings.
- STOrclass
- Indicates the SMS storage class as defined by your organization for the target host.
- TLSRFCLEVEL
- Indicates the level of RFC 4217, On Securing FTP with TLS, that is supported by the server.
- TRacks
- Indicates that primary and secondary space allocations are in tracks.
- TRAILingblanks
- Indicates whether the FTP server preserves the trailing blanks in a fixed-format data set when the data is sent to a foreign host.
- TRUNcate
- Indicates that truncation is permitted.
- UCOUNT
- Indicates the number of devices to allocate concurrently to support the allocation request.
- UCSHOSTCS
- Indicates the EBCDIC code set to be used when converting to and from Unicode.
- UCSSUB
- Indicates that in Unicode-to-EBCDIC conversion, the EBCDIC substitution character is used to replace any Unicode character that cannot be successfully converted.
- UCSTRUNC
- Indicates that in Unicode-to-EBCDIC conversion, EBCDIC data truncation is allowed.
- UMask
- Indicates the file mode creation mask.
- UNICODEFILESYSTEMBOM
- Indicates whether the FTP server will store incoming Unicode files with a byte order mark.
- Unit
- Indicates the unit type for allocation of new data sets.
- UNIXFILETYPE
- Indicates whether the FTP server treats files in its z/OS UNIX file system as regular files or as named pipes.
- VCOUNT
- Indicates the number of tape data set volumes that an allocated data set can span.
- VOLume
- Indicates the volume serial number for allocation of new data sets.
- WRAPrecord
- Indicates that data is wrapped to the next record if no new-line character is encountered before the logical record length of the receiving file is reached.
- WRTAPEFastio
- Indicates that ASCII stream data that is being written to tape can be written using BSAM I/O.
- XLate
- Indicates the translate table to be used for the data connection.
Examples
The following is an example of
the STAtus subcommand using a single parameter:
status (asatrans
>>> XSTA (asatrans
211-ASA control characters in ASA files opened for text processing
211-will be transferred as ASA control characters.
211 *** end of status ***
The following is an example
of retrieving the status information from an FTP server:
status
>>>STAT
211-Server FTP talking to host 9.117.222.59, port 23467
211-User: USER33 Working directory: /u/user33
211-The control connection has transferred 395 bytes
211-There is no current data connection.
211-The next data connection will be actively opened
211-to host 9.117.222.59, port 23467,
211-using Mode Stream, Structure File, type EBCDIC, byte-size 8
211-Automatic recall of migrated data sets.
211-Automatic mount of direct access volumes.
211-Auto tape mount is allowed.
211-Inactivity timer is disabled
211-Server site variable DSWAITTIME is set to 10
211-Server site variable DATAKEEPALIVE is set to 120
211-VCOUNT is 59
211-ASA control characters in ASA files opened for text processing
211-will be transferred as ASA control characters.
211-Trailing blanks are removed from a fixed format
211-data set when it is retrieved.
211-Data set mode. (Do not treat each qualifier as a directory.)
211-ISPFSTATS is set to FALSE
211-Primary allocation 2 tracks. Secondary allocation 1 track.
211-Partitioned data sets will be created with 27 directory blocks.
211-FileType SEQ (Sequential - default).
211-Number of access method buffers is 5
211-RDWs from variable format data sets are discarded.
211-Records on input tape are unspecified format
211-SITE DB2 subsystem name is D7A
211-Data not wrapped into next record.
211-Tape write is not allowed to use BSAM I/O
211-Truncated records will not be treated as an error
211-JESLRECL is 80
211-JESRECFM is Fixed
211-JESINTERFACELEVEL is 1
211-ENcoding is set to SBCS
211-DBSUB is set to TRUE
211-SBSUB is set to FALSE
211-SBSUBCHAR is set to SPACE
211-SMS is active.
211-New data sets will be catalogued if a store operation ends abnormally
211-Single quotes will override the current working directory.
211-UMASK value is 027
211-Process id is 50331660
211-Checkpoint interval is 0
211-Authentication type: None
211-Record format FB, Lrecl: 80, Blocksize: 3120
211-Server site variable EATTR is set to OPT
211-Server site variable DSNTYPE is set to LARGE
211-Server site variable LISTSUBDIR is set to TRUE
211 *** end of status *** Command:
Usage
The retrieved status information can be a directory, a file, or general status information, such as a summary of activity. If name is omitted, general status information is retrieved.
For further information about setting values for server initialization in the FTP.DATA data set, see the z/OS Communications Server: IP Configuration Reference.