zfsadm format
Purpose
Formats a VSAM linear data set to become a version 4
or version 5 zFS compatibility mode aggregate.
Format
zfsadm format -aggregate name [-initialempty blocks] [-size blocks] [-logsize blocks]
[-owner {uid | name}] [-group {gid | name}]
[-perms decimal | octal | hex_number] [-grow blocks]
[-system sysname] [-compat] [-overwrite]
[{-newauditfid] | -nonewauditfid}] [{-version4 | -version5}]
[-level] [-help]Options
- -aggregate name
- Specifies the name of the aggregate to be formatted. The aggregate name is not case-sensitive. It is translated to uppercase.
- -compat
- Specifies that the zFS aggregate should be formatted as a compatibility mode aggregate. That is, it should be formatted as an aggregate and then a zFS file system should be created in the aggregate. The zFS file system will have the same name as the aggregate. -compat is the default but is ignored.
- -group {gid | name}
- Specifies the group owner of the root directory of the file system. It can be specified as a z/OS® group ID or as a GID. The default is the GID of the issuer of the zfsadm format command. If only -owner is specified, the group is that owner’s default group.
- -grow blocks
- Specifies the number of 8 KB blocks that zFS uses as the increment for extension when the -size option specifies a size greater than the primary allocation.
- -help
- Prints the online help for this command. All other valid options that are specified with this option are ignored.
- -initialempty blocks
- This option is being allowed for compatibility with earlier versions and is ignored. One 8-KB block at the beginning of the aggregate is reserved for IBM® use.
- -level
- Prints the level of the zfsadm command. This option is useful when you are diagnosing a problem. Except for -help, all other valid options that are specified with -level are ignored.
- -logsize blocks
- Specifies the size in 8 KB blocks of the log. The valid range is from 13 to 16384 blocks (128 megabytes). The default is 1% of the aggregate size. This default logsize will never be smaller than 14 blocks and it will never be larger than 4096 blocks (32 megabytes). This size is normally sufficient. However, a small aggregate that is grown to be very large will still have a small log. You might want to specify a larger log if you expect the aggregate to grow very large.
- -newauditfid
- Specifies that the aggregate should be formatted with the zFS auditfid and stored in the aggregate. This is the default.
- -nonewauditfid
- Specifies that the aggregate should not be formatted with a zFS auditfid stored in it.
- -overwrite
- Specifies that an existing zFS aggregate should be overlaid. All existing data is lost. Use this option with caution. This option is not usually specified.
- -owner {uid | name}
- Specifies the owner of the root directory of the file system. It can be specified as a z/OS user ID or as a UID. The default is the UID of the issuer of the zfsadm format command.
- -perms number
- Specifies the permissions of the root directory of the file system. It can be specified as an octal number (for example, o755), as a hexadecimal number (for example, x1ED), or as a decimal number (for example, 493). The default is o755 (owner read/write-execute, group read-execute, and other read-execute.)
- -size blocks
- Specifies the number of 8 KB blocks that should be formatted to form the zFS aggregate. The default is the number of blocks that fits in the primary allocation of the VSAM linear data set. If a number less than the default is specified, it is rounded up to the default. If a number greater than the default is specified, a single extend of the VSAM linear data set is attempted after the primary allocation is formatted unless the -grow option is specified. In that case, multiple extensions of the amount that is specified in the -grow option are attempted until the -size is satisfied. Space must be available on the volume.
- -system sysname
- Specifies the system that the format request will be sent to.
- -version4
- Specifies that the aggregate should be a version 1.4 aggregate. See Usage notes for zfsadm format for the default value that is used.
- -version5
- Specifies that the aggregate should be a version 1.5 aggregate. See Usage notes for zfsadm format for the default value that is used.
Usage notes for zfsadm format
The zfsadm format command formats a VSAM linear data set as a zFS aggregate. All zFS aggregates must be formatted before use. The zfsadm format command requires the zFS PFS to be active on the system. The size of the aggregate is as many 8-KB blocks as fits in the primary allocation of the VSAM linear data set or as specified in the -size option. To extend it, use the zfsadm grow command. If -overwrite is specified, all existing primary and secondary allocations are formatted and the size includes all of that space, and the backup change activity flag is set.
If the VSAM linear data set has a SHAREOPTIONS value
of other than 3, zfsadm format changes it to SHAREOPTIONS
3 during format.
If the -overwrite option is specified,
the backup change flag is set.
The aggregate version will be as specified if the -version4 or -version5 argument is used. If neither is used, then the default aggregate version will be obtained from the zFS PFS format_aggrversion setting. See IOEFSPRM for a description of the format_aggrversion variable.
Privilege required
- Have ALTER authority to the VSAM linear data set.
- Be UID 0.
- Have READ authority to the SUPERUSER.FILESYS.PFSCTL resource in the z/OS UNIXPRIV class.
If you are using an IOEFSPRM file
in your startup proc, the issuer must have READ authority to
the data set that contains the IOEFSPRM file. If you are using parmlib
(IOEPRMxx), the issuer does not need special authorization.
Examples
zfsadm format -aggregate omvs.prev.aggr001.lds0001 -owner usera -group audit -perms o750Related information
- zfsadm define
- IOEFSPRM