The pfsctl (BPX1PCT) application programming interface is used to send requests to a physical file system. For more information, see the BPX1PCT service in z/OS UNIX System Services Programming: Assembler Callable Services Reference. zFS is a physical file system and supports several zFS-specific pfsctl functions, which are documented in this section.
BPX1PCT (File_system_type, Command, Argument_Length, Argument, Return_value, Return_code, Reason_code);
- An eight-character field. In the case of zFS, it contains the characters ZFS, followed by five blanks.
- An integer. There are five major ZFS commands:
- ZFSCALL_AGGR (0x40000005)
- ZFSCALL_CONFIG (0x40000006)
- ZFSCALL_FILESYS (0x40000004)
- ZFSCALL_FSINFO (0x40000013)
- ZFSCALL_STATS (0x40000007)
Each command has a set of subcommands.
- An integer that contains the length of the argument.
- A structure that has the pfsctl parameters followed by the subcommand parameters. The
definitions of any structures that have padding bytes added by the compiler, have the padding bytes
explicitly declared in the examples. The fields of the structures are described in the Format sections of each API. These descriptions contain structure names, field names inside the structures, the length of the field, and a brief description of what the field is used for. The lengths of the field names contain C types and are as follows:
The following list shows the general format of the Argument for all subcommands, where n depends on the particular subcommand:
unsigned intare four bytes.
unsigned long long,
long long int, and
unsigned long long intare 8 bytes.
Subcommand operation code int Parameter0 int Parameter1 int Parameter2 int Parameter3 int Parameter4 int Parameter5 int Parameter6 int Buffer[n] char[n]
- An integer that contains
0if the request is successful or
-1if it is not successful.
- An integer in which the return code is stored. For these codes, see Return codes (errnos) in z/OS UNIX System Services Messages and Codes.
- An integer that stores the reason code. If this code is of the form
0xEFnnxxxx, see EFxxrrrr reason codes in z/OS File System Messages and Codes. Otherwise, see Reason codes in z/OS UNIX System Services Messages and Codes.
Usage notes for pfsctl
- The major commands are summarized in Table 1 and described in detail in the following sections. The zFS pfsctl APIs will work across sysplex members. That is, zFS pfsctl APIs can query and set information on zFS aggregates that are owned by the current system. They can also access and set file system information from other systems in the sysplex.
- The z/OS® UNIX pfsctl (command X'C000000B') can also retrieve zFS reason code text. For more information, see the description of the PC#ErrorText pfsctl command in the usage notes for the BPX1PCT service in z/OS UNIX System Services Programming: Assembler Callable Services Reference.
- Most of the zFS pfsctl APIs have structures as input that allow a caller to specify both the version of input structures and the version of the desired output structures. Refer to the Usage Notes and Example sections of each individual zFS pfsctl API description to determine what versions need to be specified to produce the output structures that you want.
|File System||ZFSCALL_FILESYS (0x40000004)||
|File System Information||ZFSCALL_FSINFO (0x40000013)||