Configuring after installation
Configuration parameters syntax
You must conform to the following rules while specifying the parameters in the configuration data set:
- Only one parameter is allowed on each line and can start in any position on that line.
- Parameters must be specified in full and are not case-sensitive except for hierarchical file system (HFS) path names.
- A line with an asterisk * in the first position is treated as a comment.
- RSS parameters support standard z/OS ampersand-prefixed (&) variables (for example, &SYSNAME).
- (SPE2507) You can include static and dynamic system symbols in the parameters. For more information, see Using static and dynamic system symbols in parameters.
Using static and dynamic system symbols in parameters
System symbols act as placeholders and are replaced by substitution text (a character string) to maintain unique values in your shared parameter library definitions (accessible to multiple systems). There are two types of system symbols:
- Static system symbol—The substitution text for these symbols are either system-defined or defined in the IEASYMxx member via the SYMDEF subcommand processing. Static system symbols are set during IPL (Initial Program Load) and do not normally change.
- Dynamic system symbol—The substitution text for these symbols can change in real time at any point in an IPL and it is available via the IBM ASASYMBM or ASASYMBF service. You can use dynamic system symbols to build dynamic paths and file names.
Static or dynamic system symbols that you use must be defined in the "z/OS MVS Initialization and Tuning Reference" manual.
The following table lists commonly used dynamic system symbols:
| Dynamic system symbol | Description |
|---|---|
| &MON | Month of the year |
| &DAY | Day of the month |
| &JDAY | Julian day of the year |
| &YR2 | Year in two digits |
| &YR4 | Year in four digits |
| &WDAY | Name of the day of the week |
| &HR | Hour |
| &MIN | Minute |
| &SEC | Second |
| &JOBNAME | Job name of task |
| &HHMMSS | Time of day. Use &LHHMMSS for local time. |
| &YYMMDD | Date. Use &LYYMMDD for local date. |
For more information about system symbols, see the "z/OS MVS Initialization and Tuning Reference" manual.
PAMProject table
The PAM configuration statements are grouped into projects, in which a project is a specific group of PAM user IDs used to access a specific system resource.
For example, you might define one project for access to CICS, a second project for Db2, and a third project for z/OS.
The PAM configuration member (BGLASS) uses the following parameters:
Parameter | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PAMProject projectName | Indicates the start of a project definition Enter a name of up to eight characters for projectName. | ||||||||||||||||||||||||||||||
AccessRetention number type REVOKE|INACTIVE|ACTIVEONTERM | Time period to retain access to project resources Enter the following values and keywords:
Once the time is up, privileges are revoked, and any passwords the user created are removed. (SPE2410)If you omit this parameter, its value is loaded from the DefaultRetention parameter, and REVOKE is used by default. | ||||||||||||||||||||||||||||||
ACF2Mask uidMask | Indicates the uidMask used to select users for a PAM project This parameter is required for ACF2 projects. For more information, see ACF2 mask. | ||||||||||||||||||||||||||||||
AllowInactive Enable|Disable | When the product runs on a RACF system, it issues an ALU RESUME command to clear the inactive status of the requested user ID. The default is Disable. Setting the AllowInactive parameter to Enable is similar to specifying the INACTIVE keyword with the AccessRetention parameter. | ||||||||||||||||||||||||||||||
AllowRepeatedRequests All|Unique|None | Make multiple requests against your own linked user ID. The AllowRepeatedRequests parameter is valid for user pool mode (Mode UserPool) projects only and is not valid for self-elevation mode (Mode SelfElevation) projects. Select one of the following options:
The default is None. | ||||||||||||||||||||||||||||||
Approver type value | (Optional) TSO user ID or email address of the person who will approve access requests for the project This parameter is useful for sending notifications to support mailboxes or to a mailing list of approvers. Notification is not sent for automatic approvals.
| ||||||||||||||||||||||||||||||
AutoGenerate Password|Passphrase Email | Generates a random password or passphrase when a user sets or resets the password or passphrase of a user pool user ID
| ||||||||||||||||||||||||||||||
AutoGeneratedPassword On|Off|Overwrite Email | (Deprecated from SPE2507 onwards) Determines whether to automatically generate a random password during the password reset process
| ||||||||||||||||||||||||||||||
AutoPeriod hh:mm hh:mm WEEKDAYS|WEEKENDS | (Optional) Enables automatic access-request approval for the specified time period Users must receive manager approval when requesting user ID pool or self-elevation access. Managers may not always be available when access requests come in. To address such issues you can specify periods of time that approvals are given automatically. For example, on weekends or holidays when a project manager might be traveling or on vacation.
If you omit AutoPeriod, the default is that manager approval is required for all access requests. | ||||||||||||||||||||||||||||||
| AutoStep step | (SPE2507)PAMperforms the step specified with this parameter automatically after a user performs the preceding step This parameter takes the following value: Accept—automatically accepts a user ID and changes the request state to active when a manager approves a request. This value is valid for self-elevation projects only. | ||||||||||||||||||||||||||||||
BMCHelixAuth dataSet | Name of the data set containing the authentication token that is used to authenticate the change ID (or incident ID) validation request sent from PAM to the BMC Helix ITSM instance For more information, see Validating Security PAM change IDs and incident IDs by using BMC Helix ITSM. | ||||||||||||||||||||||||||||||
BMCHelixUser userID | Base64-encoded BMC Helix ITSM user ID that is used to authenticate the change ID (or incident ID) validation request sent from PAM to the BMC Helix ITSM instance Make sure that the user ID that you specify with this parameter has the required permissions to read change IDs and incident IDs in BMC Helix ITSM. For more information, see Validating Security PAM change IDs and incident IDs by using BMC Helix ITSM. | ||||||||||||||||||||||||||||||
BMCHelixPass password | Base64-encoded password for the BMC Helix ITSM userID | ||||||||||||||||||||||||||||||
BMCHelixURL url | Endpoint URL for sending the REST API requests from PAM If your endpoint URL is https://exampleurl.com, then specify it as exampleurl.com. For more information, see Validating Security PAM change IDs and incident IDs by using BMC Helix ITSM. | ||||||||||||||||||||||||||||||
ChangeIDPrefix prefix1 prefix2 prefix3 ... | Force specific change or incident ID prefixes for the project You can configure multiple, custom change or incident ID prefixes to use for tracking requests from the project. Users are shown the required prefixes when requesting a user ID. The prefixes are not case sensitive. The prefixes are displayed in the Change or Incident ID list in the UI. If PAM change or incident ID validation against ServiceNow records is enabled, the Change or Incident ID list in the UI displays CHG and INC only. No other prefix is displayed. | ||||||||||||||||||||||||||||||
CommandUserID Job|Group | User ID for issuing commands Ensure that the user ID for the specified value has sufficient privileges to issue the necessary commands.
If you omit CommandUserID, the default Job is used. | ||||||||||||||||||||||||||||||
CommentField Enable|Disable | Determines whether users must mandatorily enter a comment in the Comment box on the Confirm PAM Access Request modal window If you omit CommentField, the default Disable is used. | ||||||||||||||||||||||||||||||
ConcurrentMode True|False | (For self-elevation projects only) The project allows concurrent use in valid instances Users can self-elevate in multiple projects concurrently when:
If the user initially chooses or is currently elevated in a project where ConcurrentMode = False, they cannot concurrently elevate to another project. If you omit ConcurrentMode, the default False is used. | ||||||||||||||||||||||||||||||
ConnectACF2 priv1 priv2 priv3 ... ConnectGroup group1 group2 group3 ... ConnectProfile profile1 profile2 profile3 ... | (For self-elevation projects only) Names of the user-access ESM resources associated with the project ESM user-access resources provide projects with access to required system resources. These are primarily in the form of RACF groups, TSS profiles, and ACF2 departments. Projects created for self-elevation can connect to multiple resources, providing a wide range of access for the user. You can define multiple resources for a single Connect parameter or you can use multiple Connect parameters instead. In addition, when operating PAM on a RACF or TSS system, users are connected automatically to the RACF group or TSS profile defined specifically for the project via the RACFGroup or TSSProfile keyword. For more information, see RACF groups and TSS profiles. ACF2 supports additional processing with this keyword because of the flexibility of ACF2 installations and the various differences in the organization structure. The ConnectACF2 parameter supports any string of the format parameter(value) and two special keywords: ACCOUNT and SECURITY. The parameter options are those defined for your organization's UID string. To find the parameter, issue a LIST userid ACF2 command. The output for the command is as follows: DIV(XXX) ENDVRDEF( ) JTTL() LOC() SECT() STAFFID( ) You can specify up to 24 ACF2 departments, RACF groups, and TSS profiles with ConnectACF2, ConnectGroup, and ConnectProfile. If you exceed this limit, PAM ignores the rest and issues the following error message: Connect group limit exceeded | ||||||||||||||||||||||||||||||
CSDATAField fieldName | Name of the CSDATA field in RACF that has the project user ID that you want to link to a manager-level logon user ID When you define this parameter in a project, a manager must request and gain approval to use a project user ID that is linked to their logon user ID. This same manager can approve project user ID requests raised by other users in projects to which the manager has access. Make sure that the CSDATA field is protected by RACF to prevent unauthorized changes. For more information, see Self-managed projects. A sample code to create the CSDATA field follows: //JOBCARD JOB (),CLASS=A,MSGCLASS=X,NOTIFY=&SYSUID //*************************************************** //* BUILD PAM CUSTOM FIELDS * //*************************************************** //DEFINE EXEC PGM=IKJEFT1A //SYSTSPRT DD SYSOUT=* //SYSTSIN DD * SETROPTS CLASSACT(CFIELD) RDEFINE CFIELD + USER.CSDATA.PAMLINK + UACC(NONE) + CFDEF(TYPE(CHAR) MAXLENGTH(8) LISTHEAD('PAM LINKED ID') + FIRST(ALPHANUM) OTHER(ALPHANUM) ) //* //UPDATE EXEC PGM=IKJEFT01,PARM='IRRDPI00 UPDATE' //SYSTSPRT DD SYSOUT=* //SYSUT1 DD DISP=SHR,DSN=SYS1.SAMPLIB(IRRDPSDS) //SYSTSIN DD DUMMY //LIST EXEC PGM=IKJEFT01,PARM='IRRDPI00 LIST (USER CSDATA) ' //SYSTSPRT DD SYSOUT=* //SYSUT1 DD DISP=SHR,DSN=SYS1.SAMPLIB(IRRDPSDS) //SYSTSIN DD DUMMY //* //*************************************************** //* SET PAMLINK CSDATA FOR USERID //*************************************************** //CSDATA EXEC PGM=IKJEFT1A //SYSTSPRT DD SYSOUT=* //SYSTSIN DD * ALTUSER LogonUserID CSDATA(PAMLINK(ProjectUserID)) LISTUSER LogonUserID CSDATA //* | ||||||||||||||||||||||||||||||
DefaultRetention number type | A safeguard to ensure that both MaximumRetention and AccessRetention parameters are updated if either of them is unavailable If the MaximumRetention or AccessRetention parameter is unavailable, it is updated by using the value in the DefaultRetention parameter.
If you do not specify a value for DefaultRetention, 30 Days (the default) is used. | ||||||||||||||||||||||||||||||
Description text | Description of the project The description can be up to 31 bytes and is visible to users requesting and approving access to the project. | ||||||||||||||||||||||||||||||
ESMProfile profileName | Resource profile containing the access level requirements for the project Anyone working with this project must have the permissions defined in the specified resource profile. For more information about setting up resource profiles, see Administering. This parameter was previously known as RACFProfile. | ||||||||||||||||||||||||||||||
ExpiryNotify type value | (Optional) TSO user ID or email address for project expiry warnings Use this parameter to notify people when access for any of the project's user IDs is about to expire. First choose the method of notification and then fill in the details:
You can add multiple ExpiryNotify parameters to add multiple email recipients. If the email address is longer than 64 characters, you can enter it in two lines. To enter an email address in two lines, in the first line, specify the parameter with a + sign at its end and enter the first part of the email address. In the second line, specify the parameter again without a + sign and enter the second part of the email address. You can enter 64 characters in each line. So, you can enter an email address of up to 128 characters. For example: | ||||||||||||||||||||||||||||||
ExpiryTimer number type | Time period before access requests expire that notifications are sent (Optional) For use with ExpiryNotify, specify the amount of lead time you want for notifications before project IDs expire. The maximum value is 90 days.
If you omit ExpiryTimer, the default value of 5 minutes is used. | ||||||||||||||||||||||||||||||
LocalAuthenticate resourceProfileName | (Optional) resource profile containing the list of users permitted to use local authentication Defining this parameter enables local authentication. As a result, users on the list must enter their password only once and authenticate on the master system to gain access to all systems in the request. You must use this parameter in a multisystem configuration only and need READ or higher access to grant this privilege. This parameter controls system visibility on the UI and password authentication in the following ways:
| ||||||||||||||||||||||||||||||
MaximumRetention number type | Maximum time to retain access to project resources Enter the maximum amount of time users can retain their user pool ID or self-elevation privileges.
If the user enters a value in the Duration box when requesting a user ID that is greater than the MaximumRetention value, MaximumRetention takes precedence. If you omit type, the default Minutes is used. (SPE2410)If you omit this parameter, its value is loaded from the DefaultRetention parameter. | ||||||||||||||||||||||||||||||
Mode UserPool|SelfElevation | Access mode for project
If you omit Mode, the default UserPool is used. | ||||||||||||||||||||||||||||||
Notify activity emailAddress|CSDATA | (Optional) Sends a notification to the specified email address when the specified project activity occurs
Typically, you would enter the project manager's email address to trigger notification to that address from users. To add multiple email recipients, define multiple Notify parameters with the required email addresses. If the email address is longer than 64 characters, you can enter it in two lines. To enter an email address in two lines, in the first line, specify the parameter with a + sign at its end and enter the first part of the email address. In the second line, specify the parameter again without a + sign and enter the second part of the email address. You can enter 64 characters in each line. So, you can enter an email address of up to 128 characters. For example: | ||||||||||||||||||||||||||||||
NotifyURL protocol domain | (Optional) Adds a URL to the notification email that users receive when performing a project activity. The URL redirects users to the BMC AMI Security Logon window. This parameter takes the following values:
| ||||||||||||||||||||||||||||||
RACFGroup groupName | RACF group associated with the project Every project has an associated RACF group. For more information, see RACF groups. | ||||||||||||||||||||||||||||||
RACFProfile profileName | (Optional) RACF profile containing the access level requirements for the project Anyone working with this project must have the permissions defined in the specified RACF profile.
For a multisystem configuration, users in a self-elevation mode project must have one of the following levels of access:
If you omit RACFProfile, the default used is RSM.RSS.projectname, where projectname is the value specified in the PAMProject parameter. | ||||||||||||||||||||||||||||||
RestrictRelease Yes|No | Denies a user the privilege of releasing other user IDs that are in the same project The default is No. | ||||||||||||||||||||||||||||||
SNOWInstance instance | ServiceNow instance name used as part of PAM REST API requests. If your ServiceNow URL is https://companyName.service-now.com, replace companyName with the instance name, which you must provide in the PAM parameter file for REST API access. | ||||||||||||||||||||||||||||||
SystemList systemName1 systemName2 systemName3 ... | (Optional) Names of servers defined for the project This parameter applies if you use PAM in a multisystem configuration. Specify one or more servers that user pool or self-elevation IDs associated with the project can access. When a user requests an ID from the project, their authorization to access these servers is verified. You must make sure that all servers defined for this parameter are also defined in the PAMServers configuration block. The total list of systems for this parameter always includes the local system on which the master instance is installed. You do not need to define it here. If you omit SystemList, PAM runs as a single-system instance. | ||||||||||||||||||||||||||||||
TSSProfile profile | TSS profile associated with the project This parameter is required for TSS projects. For more information, see TSS profiles. | ||||||||||||||||||||||||||||||
UniversalMode Yes|No | Determines whether PAM should allow a manager to request a project user ID When you enable this parameter in a project, to use a project user ID, a manager must request and gain approval. The same manager can approve project user ID requests raised by other users in projects to which the manager has access. User IDs for managers must have ALTER access. User IDs for users only must have READ access. You can use this parameter with user pool mode and self-elevation mode projects. UniversalMode is mutually exclusive with the CSDATAField parameter—if you define both these parameters, PAM considers the CSDATAField configuration only and ignores UniversalMode. For more information, see Self-managed projects. | ||||||||||||||||||||||||||||||
EndPAMProject | Indicates the end of a project definition |
PAMServers table
Located on the master PAM instance, the server configuration member uses the following parameters:
Parameter | Description |
|---|---|
PAMServers | Indicates the start of the server definitions |
name ipAddress portNumber name ipAddress portNumber | Defines the agent system that PAM user IDs can access Enter the name, IP address, and port number of the servers that you want to associate with PAM. The name can be up to 15 characters and does not have to match the actual name of the server. You can repeat this parameter as many times as needed to include all desired systems. |
EndPAMServers | Indicates the end of the server definitions |
PAMAgent table
Located on the agent instance, the agent configuration member uses the following parameters:
Parameter | Description |
|---|---|
PAMAgent | Indicates the start of the agent definition |
name ipAddress | Defines the name and IP address of the local agent system Enter the name and IP address of the system that PAM user IDs will access. The name can be up to 15 characters and must match the name of a system defined in the master (PAMServers block). |
port portNumber | Defines the port number for the local agent system The number must match the port number defined in the master (PAMServers block) for the specified IP address. |
EndPAMAgent | Indicates the end of the agent definition |
PAM parameters
PAM uses the following optional configuration parameters:
| Parameter | Description |
|---|---|
| PAMParms | Indicates the start of a block of PAM definitions |
AutoGenPhraseLength Length | Length of the passphrase that PAM generates while resetting user pool user IDs and while activating user pool user IDs for use If the installation site uses RACF passphrases, you must define this parameter. Valid values are from 9 to 100. |
| PAMAgentAlertInterval interval | Controls the interval between two consecutive PAM0481I messages being displayed. interval is the interval between two consecutive PAM0481I messages in seconds. Valid values are from 60 to 86400. If you set 0, PAM0481I messages are not displayed. If you set any other values outside of this specified range, PAM displays the following error: RSS0010E Configuration error PAMAgentAlertInterval: outside valid range of 60 - 86400 If you do not define this parameter, 60 (the default) is used. |
| EndPAMParms | Indicates the end of a block of PAM definitions |