Previous Topic: CA VM:Secure User List MenuNext Topic: USER Command

Reference Guide › Command Reference › UNLOCK Command

UNLOCK Command

Use the UNLOCK command to unlock a user ID, profile, or CMS file that was previously locked by the LOCK command.

UNLOCK {"Parms"} [("Options"]

Parms:

  FILE filename filetype filemode
| PROFILE profile
| USER userid

Options:

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

Note: Options can be entered in any order.

Definitions

FILE filename filetype filemode

Specifies the CA VM:Secure file to unlock. Pattern matching in the file specification is not allowed.

PROFILE profile

Specifies the profile to unlock.

USER userid

Specifies the user ID whose directory entry to unlock.

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

These options are explained in Common API Command Options.

Description

CA VM:Secure writes permanent locks to a CMS file called PERMLOCK FILE A on the CA VM:Secure A‑disk when it creates the locks. The UNLOCK command looks for two permanent locks to clear for each user ID, profile, or CMS file being unlocked. For user IDs and profiles, the locks have the form:

SHARED DISK filename filetype filemode
PRIVATE LOCKUSER userid | profid

For CMS files, the form is:

SHARED DISK filename filetype filemode
PRIVATE LOCKFILE filename filetype filemode

When processing a user or profile entry, the LOCK and UNLOCK commands use the same internal locks as the GETENTRY and REPENTRY commands. Thus, UNLOCK can remove the locks that a GETENTRY command with the LOCK option creates. You may use the UNLOCK command if you decide not to update a user ID or profile after retrieving it with GETENTRY and the LOCK option.

Return Codes and Error Messages

The following table lists the return codes and error messages for the UNLOCK command.

Return Code

Message Number

Text

1

0127E

USER userid1 EXCEEDED USER userid2 type PASSWORD LIMIT {FOR vaddr}

2

0038E

MISSING PARAMETER

3

0531E

PARAMETER userid IS TOO LONG

4

0643E

EXTRA PARAMETERS parameters WERE ENTERED AND ARE NOT ALLOWED

10

0039E

INVALID PARAMETER parameter

11

0265E

NOT AUTHORIZED FOR: authorization words

12

0349E

PASSWORD IS INCORRECT

13

0018E

INVALID OPTION option

14

0080E

USER userid DOES NOT EXIST

15

0684E

{ USERID | PROFILE } name IS NOT LOCKED

16

0685E

FILE filename filetype filemode IS NOT LOCKED

19

0270W

PROFILE profid DOES NOT EXIST

20

0038E

MISSING PARAMETER

28

0681E

FILE filename filetype filemode DOES NOT EXIST

Note: