zfsadm define

Purpose

zfsadm define defines a VSAM linear data set that can be formatted as a zFS aggregate.

Format

zfsadm define -aggregate name
              [-keylabel label][-dataclass SMS_data_class] 
              [-managementclass SMS_management_class]          
              [-storageclass SMS_storage_class]
              [-catalog catalog][-system sysname] 
              [-modelmodel[catalog]] 
              [-volumes volume[volume ...]]  
              [-cylinders primary[secondary]]          
              [-kilobytes primary[secondary]] 
              [-megabytes primary[secondary]] 
              [-records primary[secondary]]
              [-tracks primary[secondary]]
              [-level][-help][-trace file_name]

Options

-aggregate name
Specifies the aggregate name of the aggregate to be defined. The aggregate name is the name of the VSAM linear data set that is defined. The aggregate name is not case-sensitive. It is converted to uppercase.
-catalog catalog
Specifies the name of the catalog in which the VSAM linear data set is to be defined.
-cylinders primary [secondary]
Specifies the primary and optionally, the secondary allocation size for the VSAM linear data set in cylinders. The VSAM linear data set must have a secondary allocation size that is specified, if you want to use dynamic grow. See Dynamically growing a compatibility mode aggregate for more information.
-dataclass SMS_data_class
Specifies the name of the data class to be used when the VSAM linear data set is defined.
-help
Prints the online help for this command. All other valid options that are specified with this option are ignored.
-keylabel label
Start of changeSpecifies an encryption key label that is used to locate keys in the cryptographic key data set (CKDS) when a zFS aggregate is defined. The key label is typically managed by the ICSF administrator. End of change
-kilobytes primary [secondary]
Specifies the primary and optionally, the secondary allocation size for the VSAM linear data set in kilobytes. The VSAM linear data set must have a secondary allocation size specified, if you want to use dynamic grow. See Dynamically growing a compatibility mode aggregate for additional information.
-level
Prints the level of the zfsadm command. This is useful when you are diagnosing a problem. Except for -help, all other valid options specified with -level are ignored.
-managementclass SMS_management_class
Specifies the name of the management class to be used when the VSAM linear data set is defined.
-megabytes primary [secondary]
Specifies the primary and optionally, the secondary allocation size for the VSAM linear data set in megabytes. The VSAM linear data set must have a secondary allocation size specified, if you want to use dynamic grow. See Dynamically growing a compatibility mode aggregate for additional information.
-model model [catalog]
Specifies the name of the model and optionally, the model entry’s catalog to be used when the VSAM linear data set is defined.
-records primary [secondary]
Specifies the primary and optionally, the secondary allocation size for the VSAM linear data set in records. When records is specified, the record size is assumed to be 4089 bytes. The VSAM linear data set must have a secondary allocation size specified, if you want to use dynamic grow. See Dynamically growing a compatibility mode aggregate for additional information.
-storageclass SMS_storage_class
Specifies the name of the storage class to be used when the VSAM linear data set is defined.
-system sysname
Specifies the name of the system that the define request will be sent to.
-trace file_name
Specifies the name of the file that will have the trace records written into it. The trace file can be a z/OS® UNIX file, an existing MVS sequential data set, or a member of either an existing partitioned data set (PDS) or partitioned data set extended (PDSE). Use this option only at the direction of IBM® Support.

For information about preallocation instructions for debugging, see Step 5 (Optional) Preallocate data sets for debugging in zFS installation and configuration steps.

Because MVS data set names must be fully qualified, z/OS UNIX has special rules for specifying MVS data set names in the shell environment. For more information, see Specifying MVS data set names in the shell environment in z/OS UNIX System Services Command Reference.

-tracks primary [secondary]
Specifies the primary and optionally, the secondary allocation size for the VSAM linear data set in tracks. The VSAM linear data set must have a secondary allocation size specified, if you want to use dynamic grow. See Dynamically growing a compatibility mode aggregate for additional information.
-volumes volume
Specifies the volume on which the VSAM linear data set can have space.

Usage notes

  1. The zfsadm define command defines a VSAM linear data set. The VSAM linear data set is available to be formatted as a zFS aggregate. The command creates a DEFINE CLUSTER command string for a VSAM linear data set with SHAREOPTIONS(3) and passes it to the IDCAMS utility. If a failure occurs, the zfsadm define command can display additional messages from IDCAMS indicating the reason for the failure.
  2. Starting in z/OS V2R3, the DEFINE CLUSTER command includes the ZFS parameter to indicate that this VSAM linear data set is intended to be used as a ZFS aggregate. For more information about the DEFINE CLUSTER command, see DEFINE CLUSTER in z/OS DFSMS Access Method Services Commands.

Privilege required

The issuer of the zfsadm define command requires sufficient authority to create the VSAM linear data set.

Examples

The following command defines a VSAM linear data set. 
zfsadm define -aggregate omvs.prv.aggr001.lds0001 -volumes prv000 prv001 -cylinders 10 5

Related information

Commands:
  • MOUNT
  • zfsadm format