Reference Guide › Command Reference › ENROLL Command

ENROLL Command

Use the ENROLL command to enroll a user ID in an SFS file pool.

ENROLL userid [“Parms”] [(“Options”]

Parms:

{blocks | *} [{storgrp | *} [filepool|*]]

Options:

[FILE [filename]]
[IPLstmt]
[MSG | NOMSG]
[STACK [FIFO | LIFO]]
[FIFO]
[LIFO]

Note: Options can be entered in any order.

Authorizations

You must be the SFS manager for the user ID and you must be authorized to allocate space in the affected file pools, or you must be an SFS administrator.

Definitions

userid

Specifies the user ID to enroll. The user ID must be active.

[blocks [storgrp [filepool]]]

Specifies the number of 4K blocks to allocate to the user ID, the user storage group from which to allocate this space, and the file pool from which to allocate the space. The user storage group and file pool must already be defined to CA VM:Director. The defaults for blocks, storgrp, and filepool are your default enrollment values as specified in the CA VM:Director configuration for SFS.

[IPLstmt]

Updates the IPL statement in the user ID’s directory entry to make this file pool the user ID’s default one (active when a user logs on to this user ID). If a sample profile is available or specified on a *SP= special comment in the directory entry, that profile is copied to the top‑level directory for the user as PROFILE EXEC. If there is already a PROFILE EXEC file in the user’s top‑level directory, a sample profile specified on a *SP= special comment is not copied.

[FILE [filename]]

[MSG | NOMSG]

[STACK [FIFO | LIFO]]

[FIFO]

[LIFO]

These options are explained in Common API Command Options.

Description

The ENROLL command enrolls an active user ID in an SFS file pool that is managed by CA VM:Director.

You can use your enrollment default values (unless you are the SFS administrator, in which case you must specify all values required) for the file pool, the user storage group, and the allocation size for this user ID, or you can specify values. If you specify a file pool from which to allocate space to this user ID, it must be one from which you are authorized to allocate file space through CA VM:Director; if you specify a user storage group, it must also be one from which you are authorized to allocate space.

When you allocate space, CA VM:Director checks that the amount you are trying to allocate does not exceed your allocation limit for this user storage group or the allocation limit for the user storage group itself. If either limit will be violated by this allocation, the command fails. If no limit is violated by your allocation, that amount of space is allocated to the user ID.

Return Codes and Error Messages

The table below lists return codes and error messages for the ENROLL command.

Note:

• For explanations of the message routing and disconnect options, see Common API Command Options.
• For more information about checking your default allocation values (the QUERY SFS command), see QUERY Command.
• For more information about SFS allocation limits for SFS managers and for user storage groups, see the chapter "SFS Overview" in the Administration Guide.
• For more information about special comment, see *SP= Special Comment in the chapter "Special Comment Reference" in the Administration Guide.
• For complete descriptions of all messages listed in this section, see the Message Reference Guide.