Subprograms for Object Maintenance

These subprograms can be used to perform maintenance functions on security profiles of various object types:

Subprogram Description
NSCFI Maintenance functions for files.
NSCLI   Maintenance functions for libraries.
NSCMA  Maintenance functions for mailboxes.
NSCOB Maintenance functions for external objects.
NSCUS   Maintenance functions for users.
NSCUT Maintenance functions for utilities.

The use of the subprograms for object maintenance is controlled by the general option Free Access to Functions via APIs (described in the section Administrator Services).


NSCFI

This subprogram is only available on z/OS computers, and it can only be applied to file security profiles. For DDM security profiles, you use the subprogram NSCLI (see below).

The subprogram NSCFI is used to perform maintenance/retrieval functions for file security profiles from outside of the library SYSSEC.

It is invoked as follows:

CALLNAT 'NSCFI' PFUNCTION PFILEID PFILEID2 PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT(*) PNSC-MESSAGE

An example program PGMFI001 of how to invoke this subprogram is provided in source form in the library SYSSEC. It includes descriptions of the individual CALLNAT parameters.

The example program is only available in a z/OS environment.

Example Program Description Code
PGMFI001 Perform file maintenance functions. AD, CL, CO, DE, DI, MO, RE, UP

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD  Add file.
CL  Cancel link between library and file.
CO  Copy file.
DE  Delete file.
DI  Display file.
MO  Modify file (including all components of its security profile).
RE  Establish read-link between library and file.
UP  Establish update-link between library and file.

NSCLI

The subprogram NSCLI is used to perform maintenance/retrieval functions for library security profiles from outside of library SYSSEC.

It is invoked as follows:

CALLNAT 'NSCLI' PFUNCTION PLIBID PLIBID2 PLIBTYPE PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT(*) PPARM3 PPARM4 PPARM5 PPARM6 POPRB(*) PNSC-MESSAGE

Example programs PGMLI001 - PGMLI006 of how to invoke this subprogram, as well as example programs PGMDDM01 - PGMDDM02 of how to invoke it with function code MD are provided in source form in the library SYSSEC. They include descriptions of the individual CALLNAT parameters.

The example programs PGMDDM01 - PGMDDM02 are only available on Windows and Linux.

Example Program Description Code
PGMLI001 Maintain a library profile (general options). AD, CO, DI, DL, MO, LK, RE, SL, TL
PGMLI002 Maintain a library profile (cancel link user-library, delete library, get ETID). CL, DE, ET
PGMLI003 Allow and disallow modules. DM, MM
PGMLI004 Maintain a library profile (command processors) AC, DC, LC, MC, MK, UC
PGMLI005 Maintain an entry steplib table as well as *STEPLIB. ST
PGMLI006 Retrieve and maintain library profiles with Adabas password. SL, MO
PGMDDM01 Maintain a DDM profile. MD
PGMDDM02 Maintain a DDM profile. MD, LD

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD   Add library.
CL   Cancel link between user and library.
CO   Copy library.
DE   Delete library.
DI   Display library.
DL   Display special link between user and library.
DM   Display allowed/disallowed modules.
ET   Get library ID via ETID.
LK   Link user to library.
MD   Maintain DDM profile; see also below (this function is not available on z/OS).
MM   Modify allowed/disallowed modules.
MO   Modify library (including all components of its security profile).
SL   Establish special link between user and library.
TL   Temporarily lock link between user and library.
UC   Update all "modified" command processors in the library.

If PFUNCTION is filled with function code MD, the PSUBFUNC part of the parameter PPARM has to be filled with the code for the desired subfunction. The following subfunctions are available:

Code Subfunction
AD   Add DDM profile.
CL   Cancel link between library and DDM profile.
CO   Copy DDM profile.
DE   Delete DDM profile.
DI   Display DDM profile.
MO   Modify DDM profile.
RE   Establish read-link between library and DDM profile.
UP   Establish update-link between library and DDM profile.

NSCMA

The subprogram NSCMA is used to perform maintenance/retrieval functions for mailbox security profiles from outside of the library SYSSEC.

It is invoked as follows:

CALLNAT 'NSCMA' PFUNCTION POBJID POBJID2 PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT1(*) PTEXT2(*) PNSC-MESSAGE

Example programs PGMMA001 - PGMMA002 of how to invoke this subprogram are provided in source form in the library SYSSEC. They include descriptions of the individual CALLNAT parameters.

Example Program Description Code
PGMMA001 Maintain mailbox profile. AD, DI, MO, CO, RE
PGMMA002 Delete mailbox profile. DE

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD   Add mailbox.
CO   Copy mailbox.
DE   Delete mailbox.
DI   Display mailbox.
MO   Modify mailbox (including all components of its security profile).
RE   Rename mailbox.

NSCOB

The subprogram NSCOB is only available on z/OS computers. It is used to perform maintenance/retrieval functions for external object security profiles from outside of library SYSSEC.

It is invoked as follows:

CALLNAT 'NSCOB' PFUNCTION PCLASSID POBJID POBJID2 PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT(*) PNSC-MESSAGE

Example programs PGMOB001 - PGMOB002 of how to invoke this subprogram are provided in source form in the library SYSSEC. They include descriptions of the individual CALLNAT parameters.

Example Program Description Code
PGMOB001 Maintain external object profile (general options). AD, CO, CL, DE, DI, DL, LK, MO
PGMOB002 Maintain external object profile (cancel link external object user, delete external object) CL, DE

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD   Add external object.
CL   Cancel link between user and external object.
CO   Copy external object.
DE   Delete external object.
DI   Display external object.
DL   Display link between user and external object.
LK   Link user to external object.
MO   Modify external object (including all components of its security profile).

NSCUS

The subprogram NSCUS is used to perform maintenance/retrieval functions for user security profiles from outside of library SYSSEC.

Note
NSCUS cannot be used for private libraries which may be attached to user security profiles; for maintenance/retrieval of private libraries, you use subprogram NSCLI.

NSCUS is invoked as follows:

CALLNAT 'NSCUS' PFUNCTION PUSERID PUSERID2 PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT(*) PPARM3 PPARM4 PNSC-MESSAGE

Example programs PGMUS001 - PGMUS004 of how to invoke this subprogram are provided in source form in the library SYSSEC. They include descriptions of the individual CALLNAT parameters.

Example Program Description Code
PGMUS001 Maintain user profile (general options). AD, AM, CO, CP, DI, MO, RE
PGMUS002 Maintain user profile (delete user profile, find user via ETID). DE, ET
PGMUS003 Maintain user groups. AD, DE, LI
PGMUS004 Maintain user DEFAULT profile. AD, CO, DE, DI, MO

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD   Add user.
AM   Multiple add user.
CO   Copy user.
DE   Delete user.
DI   Display user.
EG   Edit group members.
ET   Get user ID via ETID.
MO   Modify user (including all components of his/her security profile).

Note:
The user maintenance function Copy User's Links is not available via NSCUS.

For function code EG, the following subfunctions are available:

Code Subfunction
AD   Add users to a group.
DE   Delete users from a group.
LI   List group members.

NSCUT

The subprogram NSCUT is used to perform maintenance/retrieval functions for utility security profiles from outside of library SYSSEC.

It is invoked as follows:

CALLNAT 'NSCUT' PFUNCTION PUTILITY PUSER PLIBRARY PRC PPFKEY(*) PPARM PPARM1 PPARM2 PTEXT(*) PNSC-MESSAGE

An example program PGMUT001 of how to invoke this subprogram is provided in source form in the library SYSSEC. It includes descriptions of the individual CALLNAT parameters.

Example Program Description Code
PGMUT001 Maintain a library-specific utility profile, a user-specific utility profile, a user-library-specific utility profile, or display a default utility profile. AD, DE, DI, MO

The first parameter (PFUNCTION) has to be filled with the function code for the desired function. The following functions are available:

Code Function
AD Add utility.
DE Delete utility.
DI Display utility.
MO Modify utility (including all components of its security profile).

Note that the components of the security profiles are different for each utility; see also the source of PGMUT001.